@ownclouders/design-system
Version:
ownCloud Design System is based on VueDesign Systems and is used to design ownCloud UI components
34 lines (33 loc) • 1.28 kB
TypeScript
/**
* OcAvatarLink - A component for displaying a link avatar with a link icon.
*
* @prop {string} name - Name of the public link 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] - Describes the width of the avatar
* @prop {string} [iconSize='small'] - Describes the size of the avatar icon e.g.(small)
*
* @example
* ```vue
* <!-- Default usage -->
* <oc-avatar-link name="name" accessible-label="name" />
*
* <!-- Custom size -->
* <oc-avatar-link
* name="name"
* accessible-label="name"
* :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;