Fixed #1836 - For Dock

pull/1846/head
mertsincan 2021-12-01 16:34:16 +03:00
parent beb8a060e1
commit 9e8e0b4cf4
1 changed files with 92 additions and 15 deletions

View File

@ -1,28 +1,105 @@
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
import { MenuItem } from '../menuitem';
interface DockProps { type DockPositionType = 'bottom' | 'top' | 'left' | 'right';
position?: string;
model?: any[]; type DockTooltipEventType = 'hover' | 'focus';
class?: string;
export interface DockTooltipOptions {
/**
* Event to show the tooltip, valid values are hover and focus.
* @see DockTooltipEventType
*/
event: DockTooltipEventType;
/**
* Position of element.
* @see DockPositionType
* Default value is 'bottom'.
*/
position: DockPositionType;
/**
* Optional options.
*/
[key: string]: string;
}
export interface DockProps {
/**
* MenuModel instance to define the action items.
*/
model?: MenuItem[] | undefined;
/**
* Position of element.
* @see DockPositionType
* Default value is 'bottom'.
*/
position?: DockPositionType;
/**
* Style class of the element.
*/
class?: string | undefined;
/**
* Inline style of the element.
*/
style?: any; style?: any;
exact?: boolean; /**
tooltipOptions?: any; * Whether to apply 'router-link-active-exact' class if route exactly matches the item path.
* Default value is true.
*/
exact?: boolean | undefined;
/**
* Whether to display the tooltip on items. The modifiers of Tooltip can be used like an object in it. Valid keys are 'event' and 'position'.
* @see DockTooltipOptions
*/
tooltipOptions?: DockTooltipOptions;
} }
interface DockItemSlotInterface { export interface DockSlots {
item: any; /**
* Custom item content.
* @param {Object} scope - item slot's params.
*/
item: (scope: {
/**
* Custom content for item.
*/
item: MenuItem;
}) => VNode[];
/**
* Custom icon content.
* @param {Object} scope - icon slot's params.
*/
icon: (scope: {
/**
* Custom content for icon.
*/
item: MenuItem;
}) => VNode[];
} }
interface DockIconSlotInterface { export declare type DockEmits = {
item: any;
} }
declare class Dock { declare class Dock extends ClassComponent<DockProps, DockSlots, DockEmits> { }
$props: DockProps;
$slots: { declare module '@vue/runtime-core' {
item: DockItemSlotInterface; interface GlobalComponents {
icon: DockIconSlotInterface; Dock: GlobalComponentConstructor<Dock>
} }
} }
/**
*
* Dock is a navigation component consisting of menuitems.
*
* Helper API:
*
* - [MenuItem](https://www.primefaces.org/primevue/showcase/#/menumodel)
*
* Demos:
*
* - [Dock](https://www.primefaces.org/primevue/showcase/#/dock)
*
*/
export default Dock; export default Dock;