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

    Class FormGroup<CustomAttrs>

    Builds a field component based on the provided attributes. Depending on the type of input, you can set the type to 'bool', 'select', or any standard type. Any values inside the 'extra' object will be added to the component as an attribute.

    Alternatively, you can pass a callback that will be executed in ExtensionPage's context to include custom JSX elements.

    <FormGroup key="acme.checkbox"
               label={app.translator.trans('acme.admin.setting_label')}
               type="bool"
               help={app.translator.trans('acme.admin.setting_help')}
               className="Setting-item" />

    <FormGroup key="acme.select"
               label={app.translator.trans('acme.admin.setting_label')}
               type="select"
               options={{
                 'option1': 'Option 1 label',
                 'option2': 'Option 2 label',
               }}
               default="option1" />

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    attrs element state

    Methods

    $ customFieldComponents onbeforeremove onbeforeupdate oncreate oninit onremove onupdate view component initAttrs

    Constructors

    Properties

    attrs: CustomAttrs

    The attributes passed into the component.

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

    element: Element

    The root DOM element for the component.

    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.

    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

    • A list of extension-defined custom setting components to be available.

      The ItemList key represents the value for the type attribute. All attributes passed are provided as arguments to the function added to the ItemList.

      ItemList priority has no effect here.

      Returns ItemList<(attributes: CustomAttrs) => Children>

      extend(AdminPage.prototype, 'customFieldComponents', function (items) {
        // You can access the AdminPage instance with `this` to access its `settings` property.

        // Prefixing the key with your extension ID is recommended to avoid collisions.
        items.add('my-ext.setting-component', (attrs) => {
          return (
            <div className={attrs.className}>
              <label>{attrs.label}</label>
              {attrs.help && <p className="helpText">{attrs.help}</p>}

              My setting component!
            </div>
          );
        })
      })

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods