Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Page<CustomAttrs>

The Page component

abstract

Type parameters

Hierarchy

Index

Constructors

constructor

  • new Page<CustomAttrs>(): Page<CustomAttrs>

Properties

Protected attrs

attrs: CustomAttrs

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.

Protected element

element: Element

The root DOM element for the component.

Protected scrollTopOnCreate

scrollTopOnCreate: boolean = true

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

Protected 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

Protected $

  • 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

onbeforeremove

  • onbeforeremove(vnode: VnodeDOM<CustomAttrs, Page<CustomAttrs>>): void

onbeforeupdate

  • onbeforeupdate(vnode: VnodeDOM<CustomAttrs, Page<CustomAttrs>>): void

oncreate

  • oncreate(vnode: VnodeDOM<CustomAttrs, Page<CustomAttrs>>): void

oninit

  • oninit(vnode: Vnode<CustomAttrs, Page<CustomAttrs>>): void

onremove

  • onremove(vnode: VnodeDOM<CustomAttrs, Page<CustomAttrs>>): void

onupdate

  • onupdate(vnode: VnodeDOM<CustomAttrs, Page<CustomAttrs>>): void

Abstract view

  • view(vnode: Vnode<CustomAttrs, Page<CustomAttrs>>): Children

Static component

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

Static Protected initAttrs

  • initAttrs<T>(attrs: T): void

Generated using TypeDoc version 0.22.10