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.
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.
undefined by default.
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
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.
Returns the content of the AdminPage.
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.
Returns a map of settings keys to values which includes only those which have been modified but not yet saved.
Returns the number of settings that have been modified.
saveSettings completes successfully.
Returns a function that fetches the setting from the
Returns the submit button for this AdminPage.
this.saveSettings when the button is clicked.
Initialize the component's attrs.
This can be used to assign default values for missing, optional attrs.
Generated using TypeDoc version 0.22.10