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

    Class UserListPage

    Admin page which displays a paginated list of all users on the forum.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    attrs bodyClass element loading refreshAfterSaving scrollTopOnCreate settings state useBrowserScrollRestoration userCount

    Methods

    $ actionItems buildSettingComponent columns content dirty goToPage header headerInfo headerItems isChanged loadPage onbeforeremove onbeforeupdate oncreate oninit onremove onsaved onsavefailed onupdate saveSettings setting submitButton view component initAttrs modelLocale

    Constructors

    Properties

    attrs: IPageAttrs

    The attributes passed into the component.

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

    bodyClass: string = ''

    A class name to apply to the body while the route is active.

    element: Element

    The root DOM element for the component.

    loading: boolean = false
    refreshAfterSaving: string[] = []
    scrollTopOnCreate: boolean = true

    Whether we should scroll to the top of the page when its rendered.

    settings: MutableSettings = {}
    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.

    useBrowserScrollRestoration: boolean = true

    Whether the browser should restore scroll state on refreshes.

    userCount: number = app.data.modelStatistics.users.total

    Total number of forum users.

    Fetched from the active AdminApplication (app), with data provided by AdminPayload.php, or flarum/statistics if installed.

    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

    • buildSettingComponent takes a settings object and turns it into a component. 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.

      Parameters

      Returns Children

      {
         *    setting: 'acme.checkbox',
         *    label: app.translator.trans('acme.admin.setting_label'),
         *    type: 'bool',
         *    help: app.translator.trans('acme.admin.setting_help'),
         *    className: 'Setting-item'
         * }

      {
         *    setting: 'acme.select',
         *    label: app.translator.trans('acme.admin.setting_label'),
         *    type: 'select',
         *    options: {
         *      'option1': 'Option 1 label',
         *      'option2': 'Option 2 label',
         *    },
         *    default: 'option1',
         * }

      () => {
        return <p>My cool component</p>;
      }

    content

    • Asynchronously fetch the next set of users to be rendered.

      Returns an array of Users, plus the raw API payload.

      Uses the this.numPerPage as the response limit, and automatically calculates the offset required from pageNumber.

      Parameters

      • pageNumber: number

        The zero-based page number to load and display

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods