@ownclouders/design-system
Version:
ownCloud Design System is based on VueDesign Systems and is used to design ownCloud UI components
26 lines (25 loc) • 1.28 kB
TypeScript
/**
* OcAvatarGuest - A component for displaying a guest avatar with a distinctive icon.
*
* @prop {string} name - Name of the guest used as an accessible label
* @prop {string} [accessibleLabel=''] - 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"`.
* @prop {number} [width=30] - The width of the avatar in pixels. Defaults to 30px.
* @prop {string} [iconSize='small'] - The size of the guest icon. Defaults to "small".
*
* @example
* ```vue
* <!-- Default usage -->
* <oc-avatar-guest name="guest" accessible-label="guest" />
*
* <!-- Custom size -->
* <oc-avatar-guest name="external" accessible-label="external" :width="50" icon-size="medium" />
* ```
*/
interface Props {
name: string;
accessibleLabel?: string;
width?: number;
iconSize?: string;
}
declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
export default _default;