Flarum (v2.0.0-beta.2)
    Preparing search index...

    The UserSelectionModal component displays a modal dialog with searchable user list and submit button. The user can select one or more users from the list and submit them to the callback.

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    alertAttrs: AlertAttrs | null = null

    Attributes for an alert component to show below the header.

    The attributes passed into the component.

    element: Element

    The root DOM element for the component.

    focused: boolean = false
    load: throttle<() => Promise<void> | undefined> = ...
    loading: boolean = false
    results: Stream<Record<string, User[] | null>> = ...
    search: Stream<string> = ...
    selected: Stream<User[]>
    state: undefined

    Class component state that is persisted between redraws.

    Updating this will not automatically trigger a redraw, unlike other frameworks.

    This is different to Vnode state, which is always an instance of your class component.

    This is undefined by default.

    isDismissibleViaBackdropClick: boolean = true

    Can the modal be dismissed via a click on the backdrop.

    isDismissibleViaCloseButton: boolean = true

    Can the model be dismissed with a close button (X)?

    If false, no close button is shown.

    isDismissibleViaEscKey: boolean = true

    Can the modal be dismissed by pressing the Esc key on a keyboard?

    Accessors

    Methods

    • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

      For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node