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

    Class CreateUserModal<CustomAttrs>

    The FormModal component displays a modal dialog, wrapped in a form. Subclasses should implement the className, title, and content methods.

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    alertAttrs attrs bulkAdd element email loading password requireEmailConfirmation state username isDismissibleViaBackdropClick isDismissibleViaCloseButton isDismissibleViaEscKey

    Accessors

    dismissibleOptions dismissibleOptions

    Methods

    $ body className content fields hide inner loaded onbeforeremove onbeforeupdate oncreate onerror oninit onready onremove onsubmit onupdate resetData submitData title view wrapper component initAttrs

    Constructors

    Properties

    alertAttrs: AlertAttrs | null = null

    Attributes for an alert component to show below the header.

    attrs: CustomAttrs

    The attributes passed into the component.

    https://mithril.js.org/components.html#passing-data-to-components

    bulkAdd: Stream<boolean>

    Keeps the modal open after the user is created to facilitate creating multiple users at once.

    element: Element

    The root DOM element for the component.

    email: Stream<string>

    The value of the email input.

    loading: boolean = false
    password: Stream<string | null>

    The value of the password input.

    requireEmailConfirmation: Stream<boolean>

    Whether email confirmation is required after signing in.

    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.

    username: Stream<string>

    The value of the username input.

    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

    $

    • $(selector?: string): JQuery

      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

    body

    content

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods