Flarum (v2.0.0-beta.3)
    Preparing search index...

    Class Page<CustomAttrs, CustomState>Abstract

    The Page component

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    attrs bodyClass element scrollTopOnCreate state useBrowserScrollRestoration

    Methods

    $ onbeforeremove onbeforeupdate oncreate oninit onremove onupdate view component initAttrs

    Constructors

    Properties

    attrs: CustomAttrs

    The attributes passed into the component.

    https://mithril.js.org/components.html#passing-data-to-components

    bodyClass: string = ''

    A class name to apply to the body while the route is active.

    element: Element

    The root DOM element for the component.

    scrollTopOnCreate: boolean = true

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

    state: CustomState

    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.

    Methods

    $

    • $(selector?: string): JQuery

      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.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods