primevue-mirror/components/focustrap/FocusTrap.d.ts

45 lines
998 B
TypeScript

/**
*
* Focus Trap keeps focus within a certain DOM element while tabbing.
*
* - [Live Demo](https://primevue.org/focustrap)
*
* @module focustrap
*/
import { DirectiveBinding, ObjectDirective } from 'vue';
/**
* Defines options of FocusTrap.
*/
export interface FocusTrapOptions {
/**
* When present, it specifies that the directive should be disabled.
* @defaultValue false
*/
disabled?: boolean | undefined;
}
/**
* Binding of FocusTrap directive.
*/
export interface FocusTrapDirectiveBinding extends Omit<DirectiveBinding, 'modifiers' | 'value'> {
/**
* 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;