Options
All
  • Public
  • Public/Protected
  • All
Menu

The IndexPage component displays the index page, including the welcome hero, the sidebar, and the discussion list.

Hierarchy

Index

Constructors

constructor

Properties

attrs

attrs: IPageAttrs

The attributes passed into the component.

see

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

bodyClass

bodyClass: string

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

element

element: Element

The root DOM element for the component.

lastDiscussion

lastDiscussion: any

scrollTopOnCreate

scrollTopOnCreate: boolean

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

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.

Static providesInitialSearch

providesInitialSearch: boolean = true

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

actionItems

hero

  • hero(): Children

markAllAsRead

  • markAllAsRead(): void

navItems

newDiscussionAction

  • newDiscussionAction(): Promise<void>

onbeforeremove

  • onbeforeremove(vnode: any): void

onbeforeupdate

oncreate

  • oncreate(vnode: any): void

oninit

  • oninit(vnode: any): void

onremove

  • onremove(vnode: any): void

onupdate

setTitle

  • setTitle(): void

sidebarItems

  • Build an item list for the sidebar of the index page. By default this is a "New Discussion" button, and then a DropdownSelect component containing a list of navigation items.

    Returns ItemList<Children>

view

  • view(): Element

viewItems

  • Build an item list for the part of the toolbar which is concerned with how the results are displayed. By default this is just a select box to change the way discussions are sorted.

    Returns ItemList<Children>

Static component

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

Static initAttrs

  • initAttrs<T>(attrs: T): void
  • Initialize the component's attrs.

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

    Type parameters

    • T

    Parameters

    • attrs: T

    Returns void

Generated using TypeDoc version 0.22.10