@antadesign/anta
    Preparing search index...

    Interface CapturePropsUnreviewed

    Opt-in input ownership for the light-DOM capture surface.

    interface CaptureProps {
        wheelCapture?: CaptureInputDirections;
        wheelActivation?: CaptureWheelActivation;
        wheelModifier?: CaptureInputModifier;
        wheelSettle?: CaptureWheelSettle;
        onWheelInput?: (
            event: CustomEvent<CaptureWheelInput>,
            detail: CaptureWheelInput,
        ) => void;
        pointerCapture?: boolean | CapturePointerCapture;
        onPointerInput?: (
            event: CustomEvent<CapturePointerInput>,
            detail: CapturePointerInput,
        ) => void;
        pan?: boolean | CapturePan;
        onPanInput?: (
            event: CustomEvent<CapturePanInput>,
            detail: CapturePanInput,
        ) => void;
        className?: string;
        style?: CSSProperties;
        children?: ReactNode;
        id?: string;
        title?: string;
        slot?: string;
        tabIndex?: number;
        key?: string | number | null;
        [key: `data-${string}`]: unknown;
        [key: `aria-${string}`]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: `data-${string}`]: unknown

      Any data-* attribute is forwarded to the rendered element.

    • [key: `aria-${string}`]: unknown

      Any aria-* attribute is forwarded to the rendered element.

    Index
    wheelCapture? wheelActivation? wheelModifier? wheelSettle? onWheelInput? pointerCapture? onPointerInput? pan? onPanInput? className? style? children? id? title? slot? tabIndex? key?
    wheelCapture?: CaptureInputDirections

    Capture wheel input in the enabled directions and emit onWheelInput. true accepts all directions. Omit or pass false to leave wheel input alone. Nested native wheel controls, Anta menus, and contained tooltips are excluded. All-false direction bounds preserve pointer settling while declining input. A listener alone never enables capture.

    wheelActivation?: CaptureWheelActivation

    Pointer or focus condition required before wheel input can be captured. Focus applies only to input targeted within this Capture.

    settled
    wheelModifier?: CaptureInputModifier

    Required modifier for wheel capture. none preserves browser Ctrl/pinch zoom.

    none
    wheelSettle?: CaptureWheelSettle

    Dwell delay, movement tolerance, and whether movement resets eligibility.

    { delay: 150, tolerance: 5, resetOnMove: false }
    onWheelInput?: (
        event: CustomEvent<CaptureWheelInput>,
        detail: CaptureWheelInput,
    ) => void

    Accepted wheel input, with a serialized original event, Capture-relative geometry, focus state, and activation reason. Cancellation is already complete.

    pointerCapture?: boolean | CapturePointerCapture

    Emit raw data for a primary pointer until release or cancellation. An options object filters devices/buttons and configures activation. Nested interactive controls are excluded unless explicitly included. Contained tooltips are always excluded. A listener alone enables nothing.

    onPointerInput?: (
        event: CustomEvent<CapturePointerInput>,
        detail: CapturePointerInput,
    ) => void

    Start, movement, end, and cancellation of an opted-in pointer session.

    pan?: boolean | CapturePan

    Emit custom pan motion. true enables touch panning on both axes without momentum. Options select devices, axes, bounds directions, and optional inertia. Captures the pointer internally; pointerCapture is not required. Sets CSS touch-action through attributes before the gesture starts.

    onPanInput?: (
        event: CustomEvent<CapturePanInput>,
        detail: CapturePanInput,
    ) => void

    Custom pan motion and its lifecycle. Inertial samples have no native pointer event.

    className?: string

    Adds CSS classes to the root element and preserves its existing classes.

    style?: CSSProperties

    Inline CSS styles on the root element.

    children?: ReactNode

    Content to render in place of any default content.

    id?: string

    HTML id attribute.

    title?: string

    HTML title attribute, shown as a browser tooltip on hover.

    slot?: string

    Named slot in a parent web component, such as slot="header" in a <Dialog>.

    tabIndex?: number

    Tab order. Set to -1 to skip the element when tabbing.

    key?: string | number | null

    React/Preact reconciliation key when rendered inside a list. Consumed by the JSX runtime (not forwarded as a DOM attribute).

    Settings
    Member Visibility

    On This Page
    Properties