diff --git a/components/focustrap/FocusTrap.d.ts b/components/focustrap/FocusTrap.d.ts index 3a7786254..d779386c2 100644 --- a/components/focustrap/FocusTrap.d.ts +++ b/components/focustrap/FocusTrap.d.ts @@ -1,5 +1,42 @@ -import { ObjectDirective } from 'vue'; +/** + * + * Focus Trap keeps focus within a certain DOM element while tabbing. + * + * - [Live Demo](https://primevue.org/focustrap) + */ +import { DirectiveBinding, ObjectDirective } from 'vue'; -declare const Ripple: ObjectDirective; +/** + * Defines options of FocusTrap. + */ +export interface FocusTrapOptions { + /** + * When present, it specifies that the directive should be disabled. + * @defaultValue false + */ + disabled?: boolean | undefined; +} -export default Ripple; +/** + * Binding of FocusTrap directive. + */ +export interface FocusTrapDirectiveBinding extends Omit { + /** + * Value of the FocusTrap. + */ + value?: FocusTrapOptions | undefined; +} + +/** + * **PrimeVue - FocusTrap** + * + * _FocusTrap directive provides advisory information for a component._ + * + * [Live Demo](https://www.primevue.org/focustrap/) + * --- --- + * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg) + * + */ +declare const FocusTrap: ObjectDirective; + +export default FocusTrap;