diff --git a/components/breadcrumb/Breadcrumb.d.ts b/components/breadcrumb/Breadcrumb.d.ts index 7c8c660c0..14bcf9966 100755 --- a/components/breadcrumb/Breadcrumb.d.ts +++ b/components/breadcrumb/Breadcrumb.d.ts @@ -1,21 +1,33 @@ +/** + * + * Breadcrumb provides contextual information about page hierarchy. + * + * [Live Demo](https://www.primevue.org/breadcrumb/) + * + * @module breadcrumb + * + */ import { VNode } from 'vue'; import { MenuItem } from '../menuitem'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; +/** + * Defines valid properties in Breadcrumb component. + */ export interface BreadcrumbProps { /** * An array of menuitems. */ - model?: MenuItem[]; + model?: MenuItem[] | undefined; /** * Configuration for the home icon. */ - home?: MenuItem; + home?: MenuItem | undefined; /** * Whether to apply 'router-link-active-exact' class if route exactly matches the item path. - * Default value is true. + * @defaultValue true */ - exact?: boolean; + exact?: boolean | undefined; /** * Defines a string value that labels an interactive element. */ @@ -26,21 +38,39 @@ export interface BreadcrumbProps { 'aria-labelledby'?: string | undefined; } +/** + * Defines valid slots in Breadcrumb component. + */ export interface BreadcrumbSlots { /** * Custom item template. * @param {Object} scope - item slot's params. */ - item: (scope: { + item(scope: { /** * Menuitem instance */ item: MenuItem; - }) => VNode[]; + }): VNode[]; } -export declare type BreadcrumbEmits = {}; +/** + * Defines valid emits in Breadcrumb component. + */ +export interface BreadcrumbEmits {} +/** + * **PrimeVue - Breadcrumb** + * + * _Breadcrumb provides contextual information about page hierarchy._ + * + * [Live Demo](https://www.primevue.org/breadcrumb/) + * --- --- + * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg) + * + * @group Component + * + */ declare class Breadcrumb extends ClassComponent {} declare module '@vue/runtime-core' { @@ -49,17 +79,4 @@ declare module '@vue/runtime-core' { } } -/** - * - * Breadcrumb provides contextual information about page hierarchy. - * - * Helper API: - * - * - [MenuItem](https://www.primefaces.org/primevue/menumodel) - * - * Demos: - * - * - [Breadcrumb](https://www.primefaces.org/primevue/breadcrumb) - * - */ export default Breadcrumb;