Roqueform
    Preparing search index...

    Interface RefMixin

    The plugin added to fields by the refPlugin.

    interface RefMixin {
        element: null | Element;
        isFocused: boolean;
        blur(): void;
        focus(options?: FocusOptions): void;
        ref(element: null | Element): void;
        scrollIntoView(alignToTop?: boolean): void;
        scrollIntoView(options?: ScrollIntoViewOptions): void;
    }
    Index

    Properties

    element isFocused

    Methods

    blur focus ref scrollIntoView

    Properties

    element: null | Element

    The DOM element associated with the field, or null if there's no associated element.

    isFocused: boolean

    true if the DOM element is focused, or false otherwise.

    Methods

    • Blurs the field element.

      Returns void

    • Focuses the field element.

      Parameters

      Returns void

    • Associates the field with the DOM element.

      Parameters

      Returns void

    • Scrolls the field element's ancestor containers such that the field element is visible to the user.

      Parameters

      • OptionalalignToTop: boolean

        If true, the top of the element will be aligned to the top of the visible area of the scrollable ancestor, otherwise element will be aligned to the bottom of the visible area of the scrollable ancestor.

      Returns void

    • Scrolls the field element's ancestor containers such that the field element is visible to the user.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods