@nextcloud/vue
Version:
Nextcloud vue components
92 lines (91 loc) • 2.65 kB
TypeScript
declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
/**
* Unique id of the sidebar tab
*/
id: {
type: StringConstructor;
required: true;
};
/**
* Tab name in navigation
*/
name: {
type: StringConstructor;
required: true;
};
/**
* Tab icon's html class in navigation. Used if #icon slot is not provided.
*
* The #icon slot receives the tab's active state as `{ selected }`, so a
* filled icon variant can be rendered for the active tab.
*/
icon: {
type: StringConstructor;
default: string;
};
/**
* Tab order in navigation. If not provided, name is used.
*/
order: {
type: NumberConstructor;
default: number;
};
}>, {}, {}, {
/**
* Is the current tab an active tab, that should be shown?
*
* @return {boolean}
*/
isActive(): boolean;
}, {
onScroll(event: any): void;
/**
* Render tab's icon slot if any.
* The active state is passed to the slot so consumers can render a
* filled icon variant for the active tab, e.g.
* `<template #icon="{ selected }">`.
*
* @param {boolean} selected whether the tab is currently active
* @return {import('vue').VNode[]}
*/
renderIcon(selected?: boolean): import('vue').VNode[];
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("scroll" | "bottomReached")[], "scroll" | "bottomReached", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
/**
* Unique id of the sidebar tab
*/
id: {
type: StringConstructor;
required: true;
};
/**
* Tab name in navigation
*/
name: {
type: StringConstructor;
required: true;
};
/**
* Tab icon's html class in navigation. Used if #icon slot is not provided.
*
* The #icon slot receives the tab's active state as `{ selected }`, so a
* filled icon variant can be rendered for the active tab.
*/
icon: {
type: StringConstructor;
default: string;
};
/**
* Tab order in navigation. If not provided, name is used.
*/
order: {
type: NumberConstructor;
default: number;
};
}>> & Readonly<{
onScroll?: ((...args: any[]) => any) | undefined;
onBottomReached?: ((...args: any[]) => any) | undefined;
}>, {
icon: string;
order: number;
}, {}, {}, {}, "id" | "name" | "icon" | "order" | "renderIcon", import('vue').ComponentProvideOptions, true, {}, any>;
export default _default;