Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExtensionPage<Attrs>

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

attrs

attrs: Attrs

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.

changingState

changingState: boolean = false

element

element: Element

The root DOM element for the component.

extension

extension: Extension

infoFields

infoFields: { discuss: string; documentation: string; donate: string; source: string; support: string; website: string } = ...

Type declaration

  • discuss: string
  • documentation: string
  • donate: string
  • source: string
  • support: string
  • website: string

loading

loading: boolean = false

Protected scrollTopOnCreate

scrollTopOnCreate: boolean = true

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

settings

settings: MutableSettings = {}

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.

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

className

  • className(): string

content

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>

header

  • header(): Element[]

headerInfo

infoItems

isChanged

  • isChanged(): number

isEnabled

  • isEnabled(): any

onbeforeremove

  • onbeforeremove(vnode: VnodeDOM<Attrs, ExtensionPage<Attrs>>): void

onbeforeupdate

  • onbeforeupdate(vnode: VnodeDOM<Attrs, ExtensionPage<Attrs>>): void

oncreate

onerror

oninit

onremove

onsaved

  • onsaved(): void

onupdate

saveSettings

sections

setting

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

submitButton

  • submitButton(): Children

toggle

  • toggle(): void

topItems

view

  • view(vnode: VnodeDOM<Attrs, ExtensionPage<Attrs>>): null | Element

Static component

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

Static initAttrs

  • initAttrs(attrs: unknown): void

Generated using TypeDoc version 0.22.10