@ownclouders/design-system
Version:
ownCloud Design System is based on VueDesign Systems and is used to design ownCloud UI components
145 lines (144 loc) • 4.23 kB
TypeScript
/**
* Avatar is a thumbnail representing user or group
*/
declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
/**
* Source of the avatar img. If none is provided, the avatar's initials get rendered on a colorful background
*/
src: {
type: StringConstructor;
default: string;
};
/**
* User name to display initials if src is not set
*/
userName: {
type: StringConstructor;
default: string;
};
/**
* Accessibility label used as alt. Use only in case the avatar is used alone.
* In case the avatar is used next to username or display name leave empty.
* If not specified, avatar will get `aria-hidden="true"`.
**/
accessibleLabel: {
type: StringConstructor;
required: false;
default: string;
};
/**
* The size of the avatar in pixels
*/
width: {
type: NumberConstructor;
required: false;
default: number;
};
}>, {}, {
backgroundColors: string[];
imgError: boolean;
}, {
background(): string;
isImage(): boolean;
style(): {
width: string;
height: string;
lineHeight: string;
};
userInitial(): string;
}, {
onImgError(): void;
randomBackgroundColor(seed: number, colors: string[]): string;
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
/**
* Source of the avatar img. If none is provided, the avatar's initials get rendered on a colorful background
*/
src: {
type: StringConstructor;
default: string;
};
/**
* User name to display initials if src is not set
*/
userName: {
type: StringConstructor;
default: string;
};
/**
* Accessibility label used as alt. Use only in case the avatar is used alone.
* In case the avatar is used next to username or display name leave empty.
* If not specified, avatar will get `aria-hidden="true"`.
**/
accessibleLabel: {
type: StringConstructor;
required: false;
default: string;
};
/**
* The size of the avatar in pixels
*/
width: {
type: NumberConstructor;
required: false;
default: number;
};
}>> & Readonly<{}>, {
src: string;
accessibleLabel: string;
userName: string;
width: number;
}, {}, {
OcImg: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
src: {
required: true;
type: StringConstructor;
default: any;
};
alt: {
type: StringConstructor;
required: false;
default: string;
};
title: {
type: StringConstructor;
required: false;
default: any;
};
loadingType: {
type: import('vue').PropType<"lazy" | "eager">;
required: false;
default: string;
validator: (value: string) => boolean;
};
}>, {}, {}, {
ariaHidden(): boolean;
}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
src: {
required: true;
type: StringConstructor;
default: any;
};
alt: {
type: StringConstructor;
required: false;
default: string;
};
title: {
type: StringConstructor;
required: false;
default: any;
};
loadingType: {
type: import('vue').PropType<"lazy" | "eager">;
required: false;
default: string;
validator: (value: string) => boolean;
};
}>> & Readonly<{}>, {
title: string;
src: string;
alt: string;
loadingType: "lazy" | "eager";
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
export default _default;