/** * * When pressed, a floating action button can display multiple primary actions that can be performed on a page. * * [Live Demo](https://www.primevue.org/speeddial/) * * @module speeddial * */ import { VNode } from 'vue'; import { MenuItem } from '../menuitem'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; /** * Defines tooltip options. * @see {@link SpeedDialProps.tooltipOptions} */ export interface SpeedDialTooltipOptions { /** * Event to show the tooltip, valid values are hover and focus. */ event: 'hover' | 'focus' | undefined; /** * Position of element. * @defaultValue bottom */ position: 'bottom' | 'top' | 'left' | 'right' | undefined; /** * Optional options. */ [key: string]: any; } /** * Defines valid properties in SpeedDial component. */ export interface SpeedDialProps { /** * MenuModel instance to define the action items. */ model?: MenuItem[] | undefined; /** * Specifies the visibility of the overlay. * @defaultValue false */ visible?: boolean | undefined; /** * Specifies the opening direction of actions. * @defaultValue up */ direction?: 'up' | 'down' | 'left' | 'right' | 'up-left' | 'up-right' | 'down-left' | 'down-right' | undefined; /** * Transition delay step for each action item. * @defaultValue 30 */ transitionDelay?: number | undefined; /** * Specifies the opening type of actions. * @defaultValue linear */ type?: 'linear' | 'circle' | 'semi-circle' | 'quarter-circle' | undefined; /** * Radius for *circle types. * @defaultValue 0 */ radius?: number | undefined; /** * Whether to show a mask element behind the speeddial. * @defaultValue false */ mask?: boolean | undefined; /** * Whether the component is disabled. * @defaultValue false */ disabled?: boolean | undefined; /** * Whether the actions close when clicked outside. * @defaultValue true */ hideOnClickOutside?: boolean | undefined; /** * Style class of the button element. */ buttonClass?: any; /** * Inline style of the mask element. */ maskStyle?: any; /** * Style class of the mask element. */ maskClass?: string | undefined; /** * Show icon of the button element. */ showIcon?: string | undefined; /** * Hide icon of the button element. */ hideIcon?: string | undefined; /** * Defined to rotate showIcon when hideIcon is not present. * @defaultValue true */ rotateAnimation?: boolean | undefined; /** * Style class of the element. */ class?: any; /** * Inline style of the element. */ style?: any; /** * 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'. * @type {SpeedDialTooltipOptions} */ tooltipOptions?: SpeedDialTooltipOptions; /** * Defines a string value that labels an interactive list element. */ 'aria-label'?: string | undefined; /** * Identifier of the underlying list element. */ 'aria-labelledby'?: string | undefined; } /** * Defines valid slots in SpeedDial component. */ export interface SpeedDialSlots { /** * Custom content for each item. * @param {Object} scope - item slot's params. */ item(scope: { /** * Menuitem instance * @type {MenuItem} */ item: MenuItem; }): VNode[]; /** * Custom button template. * @param {Object} scope - button slot's params. */ button(scope: { /** * Toggle metadata */ toggle(): void; }): VNode[]; } /** * Defines valid emits in SpeedDial component. */ export interface SpeedDialEmits { /** * Fired when the button element clicked. * @param {Event} event - Browser event. */ click(event: Event): void; /** * Fired when the actions are visible. */ show(): void; /** * Fired when the actions are hidden. */ hide(): void; /** * Callback to invoke when the component receives focus. * @param {Event} event - Browser event. */ focus(event: Event): void; /** * Callback to invoke when the component loses focus. * @param {Event} event - Browser event. */ blur(event: Event): void; } /** * **PrimeVue - SpeedDial** * * _When pressed, a floating action button can display multiple primary actions that can be performed on a page._ * * [Live Demo](https://www.primevue.org/speeddial/) * --- --- * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) * * @group Component * */ declare class SpeedDial extends ClassComponent {} declare module '@vue/runtime-core' { interface GlobalComponents { SpeedDial: GlobalComponentConstructor; } } export default SpeedDial;