Interface RefPlugin

The plugin added to fields by the refPlugin.

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

Properties

element isFocused

Methods

blur focus ref scrollIntoView

Properties

element

element: null | Element

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

ReadonlyisFocused

isFocused: boolean

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

Methods

blur

  • blur(): void

  • Blurs the field element.

    Returns void

focus

  • focus(options?): void

  • Focuses the field element.

    Parameters

    Returns void

ref

  • ref(element): void

  • Associates the field with the DOM element.

    Parameters

    Returns void

scrollIntoView

  • scrollIntoView(alignToTop?): 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

  • scrollIntoView(options?): 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