Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserListPage

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

attrs

attrs: IPageAttrs

The attributes passed into the component.

see

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

Protected bodyClass

bodyClass: string = ''

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

element

element: Element

The root DOM element for the component.

Private isLoadingPage

isLoadingPage: boolean = false

loading

loading: boolean = false

Private moreData

moreData: boolean = false

Are there more users available?

Private numPerPage

numPerPage: number = 50

Number of users to load per page.

Private pageData

pageData: undefined | User[] = undefined

This page's array of users.

undefined when page loads as no data has been fetched.

Private pageNumber

pageNumber: number = 0

Current page number. Zero-indexed.

Protected scrollTopOnCreate

scrollTopOnCreate: boolean = true

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

settings

settings: Record<string, Stream<string>> = {}

state

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.

Protected useBrowserScrollRestoration

useBrowserScrollRestoration: boolean = true

Whether the browser should restore scroll state on refreshes.

Readonly userCount

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

$

  • 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.

    final

    Parameters

    • Optional selector: string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

buildSettingComponent

  • 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.

    example

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

    example

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

    example

    () => { return

    My cool component

    ; }

    Parameters

    Returns Children

columns

  • Build an item list of columns to show for each user.

    Each column in the list should be an object with keys name and content.

    name is a string that will be used as the column name. content is a function with the User model passed as the first and only argument.

    See UserListPage.tsx for examples.

    Returns ItemList<ColumnData>

content

  • content(): Element[]

customSettingComponents

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

    The ItemList key represents the value for type to be provided when calling AdminPage.buildSettingComponent. Other attributes passed are provided as arguments to the function added to the ItemList.

    ItemList priority has no effect here.

    example
    extend(AdminPage.prototype, 'customSettingComponents', 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 class="helpText">{attrs.help}</p>}

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

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

dirty

  • dirty(): Record<string, string>

Private getTotalPageCount

  • getTotalPageCount(): number

header

headerInfo

isChanged

  • isChanged(): number

loadPage

  • loadPage(pageNumber: number): Promise<void>

  • 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 page number to load and display

    Returns Promise<void>

nextPage

  • nextPage(): void

onbeforeremove

onbeforeupdate

oncreate

oninit

onremove

onsaved

  • onsaved(): void

onupdate

previousPage

  • previousPage(): void

saveSettings

  • saveSettings(e: SubmitEvent & { redraw: boolean }): Promise<void>

setting

  • setting(key: string, fallback?: string): Stream<string>

submitButton

view

Static component

  • component<SAttrs>(attrs?: SAttrs, children?: Children): Vnode<{}, {}>

Static initAttrs

  • initAttrs<T>(attrs: T): void

Generated using TypeDoc version 0.22.10