The attributes passed into the component.
ProtectedbodyA class name to apply to the body while the route is active.
The root DOM element for the component.
ProtectedscrollWhether 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.
ProtecteduseWhether the browser should restore scroll state on refreshes.
StaticDEFAULT_The id of the tab that holds the settings when a page registers no tabs of its own.
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.
Optionalselector: string
a jQuery-compatible selector string
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. Field attributes are forwarded to the FormGroup; the
search-only link option is not.
Alternatively, you can pass a callback that will be executed in ExtensionPage's context to include custom JSX elements.
{
* setting: 'acme.checkbox',
* label: app.translator.trans('acme.admin.setting_label'),
* type: 'bool',
* help: app.translator.trans('acme.admin.setting_help'),
* className: 'Setting-item'
* }
Returns the content of the AdminPage.
Returns a map of settings keys to values which includes only those which have been modified but not yet saved.
Returns the Header component for this AdminPage.
Returns the number of settings that have been modified.
Renders an ItemList as titled sections, keeping the list's keys and priorities.
Each section names the item keys it holds. An item it doesn't name, such as one another extension added, joins the section of the item before it, so it stays where it was shown before. Items before the first named one are shown without a heading.
Shown by settingsForm() when there are no settings to show.
Called when saveSettings completes successfully.
Called when saveSettings fails to complete.
Returns a button that opens a confirmation modal to delete all settings tracked by this page from the database, reverting them to their PHP-side defaults.
Calls can pass an explicit list of setting keys to reset; otherwise all keys
currently tracked in this.settings are used.
Optionaltitle: stringOptionalextensionId: stringOne control per registered token type, so a type added by an extension is configured here alongside the ones core ships.
Returns a function that fetches the setting from the app global.
An optional label can be provided to associate a human-readable label
with the setting key, which is used by resetButton() in the reset modal.
Optionallabel: ChildrenThe registered settings, grouped into their sections, followed by the save controls.
Only show the settings on this tab; null shows them all.
The buttons under the settings form.
The registered settings on a tab, in display order, split into their sections.
null for every tab.
The AdminRegistry key whose registered settings this page shows: an
extension id, or a core page's key such as core-basics. null when the
page builds its settings itself.
The registered settings on a tab, grouped into their sections, as one
SettingsSection each. Settings before the first section come first, without a heading.
The id of the tab a registered setting is shown on.
Returns the submit button for this AdminPage.
Calls this.saveSettings when the button is clicked.
A name for a token type. Types core knows about are named properly; one added by an extension falls back to its own identifier rather than going unlabelled.
StaticcomponentConvenience method to attach a component without JSX.
Has the same effect as calling m(THIS_CLASS, attrs, children).
StaticinitInitialize the component's attrs.
This can be used to assign default values for missing, optional attrs.
StaticmodelStaticregister
The
Pagecomponent