The attributes passed into the component.
A class name to apply to the body while the route is active.
The root DOM element for the component.
Are there more users available?
Number of users to load per page.
This page's array of users.
undefined when page loads as no data has been fetched.
Current page number. Zero-indexed.
Whether we should scroll to the top of the page when its rendered.
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.
Whether the browser should restore scroll state on refreshes.
Total number of forum users.
Fetched from the active AdminApplication (app), with
data provided by AdminPayload.php, or flarum/statistics
if installed.
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.
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.
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.
Component to render.
Returns a map of settings keys to values which includes only those which have been modified but not yet saved.
Get total number of user pages.
Returns the Header component for this AdminPage.
Returns the options passed to the AdminHeader component.
Returns the number of settings that have been modified.
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.
The page number to load and display
Called when saveSettings completes successfully.
Saves the modified settings to the database.
Returns a function that fetches the setting from the app global.
Returns the submit button for this AdminPage.
Calls this.saveSettings when the button is clicked.
Convenience method to attach a component without JSX.
Has the same effect as calling m(THIS_CLASS, attrs, children).
Initialize the component's attrs.
This can be used to assign default values for missing, optional attrs.
Generated using TypeDoc version 0.22.10
Admin page which displays a paginated list of all users on the forum.