useFocusTrap

This composable function is used to trap focus within a container.

Usage

import { useFocusTrap } from '@flux-ui/internals';
import { useTemplateRef } from 'vue';

const element = useTemplateRef('element');

useFocusTrap(element);

Type declarations

import type { TemplateRef } from '@flux-ui/internals';
import type { Ref } from 'vue';

export declare function useFocusTrap(
    containerRef: TemplateRef<HTMLElement>,
    options: UseFocusTrapOptions = {}
): void;

type UseFocusTrapOptions = {
    attachTo?: HTMLElement | Document;
    disable?: Ref<boolean>;
    disableReturn?: Ref<boolean>;
};

Used by

• Flyout