Class AdminPage<CustomAttrs>Abstract

The Page component


Type Parameters




attrs: CustomAttrs

The attributes passed into the component.


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


  • 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



    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

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


    * 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: '',
    * 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>;


    Returns Children

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

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

    ItemList priority has no effect here.


    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}>
    { && <p class="helpText">{}</p>}

    My setting component!

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

  • Returns a map of settings keys to values which includes only those which have been modified but not yet saved.

    Returns Record<string, string>

  • Returns a function that fetches the setting from the app global.


    • key: string
    • fallback: string = ''

    Returns Stream<string>

  • Returns the submit button for this AdminPage.

    Calls this.saveSettings when the button is clicked.

    Returns Children

  • Initialize the component's attrs.

    This can be used to assign default values for missing, optional attrs.


    • attrs: unknown

    Returns void

Generated using TypeDoc v0.23.24