Flarum (2.x)
    Preparing search index...

    Class SettingsSection<CustomAttrs>

    A titled group of settings on an admin page.

    The heading and description sit above the fields at every screen size.

    <SettingsSection label="Notifications" description="When we email your members." icon="fas fa-bell">
    {this.buildSettingComponent({ setting: 'acme.notify', type: 'bool', label: 'Notify on reply' })}
    </SettingsSection>

    Type Parameters

    Hierarchy (View Summary)

    Index

    The attributes passed into the component.

    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.

    • 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