@ownclouders/design-system
Version:
ownCloud Design System is based on VueDesign Systems and is used to design ownCloud UI components
373 lines (372 loc) • 11.6 kB
TypeScript
/**
* Notifications are used to inform users about errors, warnings and as confirmations for their actions.
*/
declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
/**
* Notification messages are sub components of the oc-notifications component.
* Messages can have one of the five states: `passive, primary, success, warning and danger`
*
* The status defines the color of the notification.
*/
status: {
type: StringConstructor;
required: false;
default: string;
validator: (value: string) => boolean;
};
/**
* The title that will be displayed in notification
*/
title: {
type: StringConstructor;
required: true;
};
/**
* The message that will be displayed in notification
*/
message: {
type: StringConstructor;
required: false;
default: any;
};
/**
* The error log content that will be displayed in notification
*/
errorLogContent: {
type: StringConstructor;
required: false;
default: any;
};
/**
* Number of seconds the message shows. It will disappear after this time.
* If set to 0, message won't disappear automatically.
*/
timeout: {
type: NumberConstructor;
required: false;
default: number;
validator: (value: number) => boolean;
};
}>, {
showErrorLog: import('vue').Ref<boolean, boolean>;
}, {}, {
classes(): string;
iconVariation(): string;
isStatusDanger(): boolean;
role(): "alert" | "status";
ariaLive(): "assertive" | "polite";
}, {
close(): void;
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, "close"[], "close", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
/**
* Notification messages are sub components of the oc-notifications component.
* Messages can have one of the five states: `passive, primary, success, warning and danger`
*
* The status defines the color of the notification.
*/
status: {
type: StringConstructor;
required: false;
default: string;
validator: (value: string) => boolean;
};
/**
* The title that will be displayed in notification
*/
title: {
type: StringConstructor;
required: true;
};
/**
* The message that will be displayed in notification
*/
message: {
type: StringConstructor;
required: false;
default: any;
};
/**
* The error log content that will be displayed in notification
*/
errorLogContent: {
type: StringConstructor;
required: false;
default: any;
};
/**
* Number of seconds the message shows. It will disappear after this time.
* If set to 0, message won't disappear automatically.
*/
timeout: {
type: NumberConstructor;
required: false;
default: number;
validator: (value: number) => boolean;
};
}>> & Readonly<{
onClose?: (...args: any[]) => any;
}>, {
status: string;
message: string;
errorLogContent: string;
timeout: number;
}, {}, {
OcErrorLog: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
content: {
type: StringConstructor;
required: true;
};
}>, {
contentLabel: import('vue').ComputedRef<string>;
showCopied: import('vue').Ref<boolean, boolean>;
copyContentToClipboard: () => void;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
content: {
type: StringConstructor;
required: true;
};
}>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
OcIcon: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
name: {
type: StringConstructor;
default: string;
};
fillType: {
type: StringConstructor;
required: false;
default: string;
validator: (value: string) => boolean;
};
accessibleLabel: {
type: StringConstructor;
default: string;
};
type: {
type: StringConstructor;
default: string;
};
size: {
type: StringConstructor;
default: string;
validator: (value: unknown) => boolean;
};
variation: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
color: {
type: StringConstructor;
required: false;
default: string;
};
}>, {}, {}, {
svgTitleId(): string;
nameWithFillType(): string;
}, {
sizeClass(c: string): string;
variationClass(c: string): string;
prefix(string: string): string;
transformSvgElement(svg: SVGElement): SVGElement;
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, "loaded"[], "loaded", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
name: {
type: StringConstructor;
default: string;
};
fillType: {
type: StringConstructor;
required: false;
default: string;
validator: (value: string) => boolean;
};
accessibleLabel: {
type: StringConstructor;
default: string;
};
type: {
type: StringConstructor;
default: string;
};
size: {
type: StringConstructor;
default: string;
validator: (value: unknown) => boolean;
};
variation: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
color: {
type: StringConstructor;
required: false;
default: string;
};
}>> & Readonly<{
onLoaded?: (...args: any[]) => any;
}>, {
name: string;
type: string;
fillType: string;
accessibleLabel: string;
size: string;
variation: string;
color: string;
}, {}, {
InlineSvg: import('vue').DefineComponent<import('vue-inline-svg').InlineSvgProps, unknown, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, Record<string, any>, string, import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, import('vue-inline-svg').InlineSvgProps>;
}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
OcButton: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
type: {
type: StringConstructor;
default: string;
validator: (value: any) => boolean;
};
disabled: {
type: BooleanConstructor;
default: boolean;
};
size: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
href: {
type: StringConstructor;
default: any;
};
target: {
type: StringConstructor;
default: any;
validator: (value: string) => boolean;
};
to: {
type: import('vue').PropType<import('vue-router').RouteLocationRaw>;
default: any;
};
ariaLabel: {
type: StringConstructor;
default: any;
};
submit: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
variation: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
appearance: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
justifyContent: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
gapSize: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
showSpinner: {
type: BooleanConstructor;
default: boolean;
};
}>, {}, {}, {
$_ocButton_buttonClass(): string[];
additionalAttributes(): {
disabled: boolean;
type: string;
to: import('vue-router').RouteLocationRaw;
target: string;
href: string;
};
handlers(): {
click: (event: MouseEvent) => void;
};
}, {
$_ocButton_onClick(event: MouseEvent): void;
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, "click"[], "click", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
type: {
type: StringConstructor;
default: string;
validator: (value: any) => boolean;
};
disabled: {
type: BooleanConstructor;
default: boolean;
};
size: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
href: {
type: StringConstructor;
default: any;
};
target: {
type: StringConstructor;
default: any;
validator: (value: string) => boolean;
};
to: {
type: import('vue').PropType<import('vue-router').RouteLocationRaw>;
default: any;
};
ariaLabel: {
type: StringConstructor;
default: any;
};
submit: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
variation: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
appearance: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
justifyContent: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
gapSize: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
showSpinner: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{
onClick?: (...args: any[]) => any;
}>, {
type: string;
size: string;
variation: string;
target: string;
disabled: boolean;
href: string;
to: import('vue-router').RouteLocationRaw;
ariaLabel: string;
submit: string;
appearance: string;
justifyContent: string;
gapSize: string;
showSpinner: boolean;
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
export default _default;