@opencloud-eu/design-system
Version:
OpenCloud Design System is used to design OpenCloud UI components
77 lines (76 loc) • 2.34 kB
TypeScript
import { SizeType } from '../../helpers';
type Item = {
displayName?: string;
name?: string;
avatarType?: 'user' | 'link' | 'remote' | 'group' | 'guest' | string;
username?: string;
avatar?: string;
};
export interface Props {
/**
* @docs List of items to display. Please refer to the component source for the `Item` type definition.
*/
items: Item[];
/**
* @docs Accessible description for the component.
*/
accessibleDescription?: string;
/**
* @docs Determines if the tooltip is displayed when hovering over the component.
* @default false
*/
isTooltipDisplayed?: boolean;
/**
* @docs Maximum number of items to display. If the number of items is greater than this value, a `+X` counter will be displayed.
*/
maxDisplayed?: number;
/**
* @docs Determines if the avatars are displayed in a stacked layout.
* @default false
*/
stacked?: boolean;
/**
* @docs Determines if the stacked avatars show a hover effect.
* @default false
*/
hoverEffect?: boolean;
/**
* @docs The gap size between the avatars.
* @default xsmall
*/
gapSize?: SizeType | 'none';
/**
* @docs The icon size of the individual avatars.
* @default small
*/
iconSize?: SizeType;
/**
* @docs The width of the individual avatars.
* @default 30
*/
width?: number;
}
declare function __VLS_template(): {
attrs: Partial<{}>;
slots: {
userAvatars?(_: {
avatars: Item[];
width: number;
}): any;
};
refs: {
avatarsRef: HTMLSpanElement;
};
rootEl: HTMLSpanElement;
};
type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
declare const __VLS_component: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
avatarsRef: HTMLSpanElement;
}, HTMLSpanElement>;
declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
export default _default;
type __VLS_WithTemplateSlots<T, S> = T & {
new (): {
$slots: S;
};
};