@vuecs/navigation
Version:
A package for multi level navigations.
173 lines • 5.62 kB
TypeScript
import type { ThemeClassesOverride, VariantValues } from '@vuecs/core';
import type { Component, ExtractPublicPropTypes, PropType, SlotsType } from 'vue';
import type { NavigationItemNormalized, NavigationOrientation, NavigationSubmenuMode } from '../../types';
import type { NavigationThemeClasses } from '../../helpers/component/types';
import type { NavItemLinkSlotProps, NavItemSeparatorSlotProps, NavItemSubItemsSlotProps, NavItemSubSlotProps, NavItemSubTitleSlotProps } from '../type';
declare const navItemProps: {
data: {
type: PropType<NavigationItemNormalized>;
required: boolean;
};
variant: {
type: StringConstructor;
default: any;
};
orientation: {
type: PropType<NavigationOrientation>;
default: any;
};
/**
* Resolved submenu presentation handed down by the parent
* `<VCNavItems>`. `collapse` renders groups as an inline
* Reka `Collapsible`; `dropdown` renders them as Reka
* `NavigationMenu` flyouts.
*/
submenu: {
type: PropType<NavigationSubmenuMode>;
default: string;
};
/**
* The tag (or component) this item renders as — its own wrapper
* (`<li>` by default). Receives `<VCNavItems>`' `itemAs`. Honored in
* collapse mode only.
*/
as: {
type: PropType<string | Component>;
default: string;
};
/**
* The list-container tag for this item's nested submenu
* `<VCNavItems>` (`<ul>` by default). Receives `<VCNavItems>`' `as`.
* Honored in collapse mode only.
*/
itemsAs: {
type: PropType<string | Component>;
default: string;
};
themeClass: {
type: PropType<ThemeClassesOverride<NavigationThemeClasses>>;
default: any;
};
themeVariant: {
type: PropType<VariantValues>;
default: any;
};
};
export type NavItemProps = ExtractPublicPropTypes<typeof navItemProps>;
export declare const VCNavItem: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
data: {
type: PropType<NavigationItemNormalized>;
required: boolean;
};
variant: {
type: StringConstructor;
default: any;
};
orientation: {
type: PropType<NavigationOrientation>;
default: any;
};
/**
* Resolved submenu presentation handed down by the parent
* `<VCNavItems>`. `collapse` renders groups as an inline
* Reka `Collapsible`; `dropdown` renders them as Reka
* `NavigationMenu` flyouts.
*/
submenu: {
type: PropType<NavigationSubmenuMode>;
default: string;
};
/**
* The tag (or component) this item renders as — its own wrapper
* (`<li>` by default). Receives `<VCNavItems>`' `itemAs`. Honored in
* collapse mode only.
*/
as: {
type: PropType<string | Component>;
default: string;
};
/**
* The list-container tag for this item's nested submenu
* `<VCNavItems>` (`<ul>` by default). Receives `<VCNavItems>`' `as`.
* Honored in collapse mode only.
*/
itemsAs: {
type: PropType<string | Component>;
default: string;
};
themeClass: {
type: PropType<ThemeClassesOverride<NavigationThemeClasses>>;
default: any;
};
themeVariant: {
type: PropType<VariantValues>;
default: any;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
data: {
type: PropType<NavigationItemNormalized>;
required: boolean;
};
variant: {
type: StringConstructor;
default: any;
};
orientation: {
type: PropType<NavigationOrientation>;
default: any;
};
/**
* Resolved submenu presentation handed down by the parent
* `<VCNavItems>`. `collapse` renders groups as an inline
* Reka `Collapsible`; `dropdown` renders them as Reka
* `NavigationMenu` flyouts.
*/
submenu: {
type: PropType<NavigationSubmenuMode>;
default: string;
};
/**
* The tag (or component) this item renders as — its own wrapper
* (`<li>` by default). Receives `<VCNavItems>`' `itemAs`. Honored in
* collapse mode only.
*/
as: {
type: PropType<string | Component>;
default: string;
};
/**
* The list-container tag for this item's nested submenu
* `<VCNavItems>` (`<ul>` by default). Receives `<VCNavItems>`' `as`.
* Honored in collapse mode only.
*/
itemsAs: {
type: PropType<string | Component>;
default: string;
};
themeClass: {
type: PropType<ThemeClassesOverride<NavigationThemeClasses>>;
default: any;
};
themeVariant: {
type: PropType<VariantValues>;
default: any;
};
}>> & Readonly<{}>, {
variant: string;
orientation: NavigationOrientation;
submenu: NavigationSubmenuMode;
as: string;
itemsAs: string;
themeClass: ThemeClassesOverride<NavigationThemeClasses>;
themeVariant: VariantValues;
}, SlotsType<{
separator: NavItemSeparatorSlotProps;
link: NavItemLinkSlotProps;
sub: NavItemSubSlotProps;
'sub-title': NavItemSubTitleSlotProps;
'sub-items': NavItemSubItemsSlotProps;
}>, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export {};
//# sourceMappingURL=module.d.ts.map