@nextcloud/vue
Version:
Nextcloud vue components
96 lines (95 loc) • 3.02 kB
TypeScript
import { Slot } from 'vue';
type __VLS_Props = {
/**
* aria label to set on the close button
*
* @default 'Close'
*/
ariaLabelClose?: string;
/**
* Container for the actions
*/
actionsContainer?: string;
/**
* Main text of the chip.
*/
text?: string;
/**
* SVG path of the icon to use, this takes precedence over `iconSVG`.
* For example icon paths from `@mdi/js` can be used.
*/
iconPath?: string;
/**
* Inline SVG to use as the icon
*/
iconSvg?: string;
/**
* Set to true to prevent the close button to be shown
*/
noClose?: boolean;
/**
* Set the chips design variant-
*
* This sets the background style of the chip, similar to NcButton's `variant`.
*
* @default 'secondary'
* @since 8.23.0
*/
variant?: 'primary' | 'secondary' | 'tertiary' | 'error' | 'warning' | 'success';
};
declare function __VLS_template(): {
attrs: Partial<{}>;
slots: Readonly<{
/**
* The actions slot can be used to add custom actions (`NcAction*`) to the chips actions.
*/
actions?: Slot;
/**
* The default slot can be used to set the text that is shown.
*/
default?: Slot;
/**
* The icon slot can be used to set the chip icon.
* Make sure that the icon is not exceeding a height of `--chip-size`.
* For round icons a exact size of `var(--chip-size)` is recommended.
*/
icon?: Slot;
}> & {
/**
* The actions slot can be used to add custom actions (`NcAction*`) to the chips actions.
*/
actions?: Slot;
/**
* The default slot can be used to set the text that is shown.
*/
default?: Slot;
/**
* The icon slot can be used to set the chip icon.
* Make sure that the icon is not exceeding a height of `--chip-size`.
* For round icons a exact size of `var(--chip-size)` is recommended.
*/
icon?: Slot;
};
refs: {};
rootEl: HTMLDivElement;
};
type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
close: () => any;
}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
onClose?: (() => any) | undefined;
}>, {
text: string;
variant: "primary" | "secondary" | "tertiary" | "error" | "warning" | "success";
iconSvg: string;
iconPath: string;
ariaLabelClose: string;
actionsContainer: string;
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
export default _default;
type __VLS_WithTemplateSlots<T, S> = T & {
new (): {
$slots: S;
};
};