primevue-mirror/components/lib/breadcrumb/Breadcrumb.d.ts

83 lines
1.9 KiB
TypeScript
Executable File

/**
*
* 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[] | undefined;
/**
* Configuration for the home icon.
*/
home?: MenuItem | undefined;
/**
* Whether to apply 'router-link-active-exact' class if route exactly matches the item path.
* @defaultValue true
*/
exact?: boolean | undefined;
/**
* Defines a string value that labels an interactive element.
*/
'aria-label'?: string | undefined;
/**
* Identifier of the underlying menu element.
*/
'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: {
/**
* Menuitem instance
*/
item: MenuItem;
}): VNode[];
}
/**
* 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-100.png)
*
* @group Component
*
*/
declare class Breadcrumb extends ClassComponent<BreadcrumbProps, BreadcrumbSlots, BreadcrumbEmits> {}
declare module '@vue/runtime-core' {
interface GlobalComponents {
Breadcrumb: GlobalComponentConstructor<Breadcrumb>;
}
}
export default Breadcrumb;