Class IndexPage<CustomAttrs, CustomState>

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

Type Parameters


  • Page<CustomAttrs, CustomState>
    • IndexPage



attrs: CustomAttrs

The attributes passed into the component.


bodyClass: string = ''

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

element: Element

The root DOM element for the component.

lastDiscussion?: Discussion
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.

providesInitialSearch: boolean = true


  • 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.


    the jQuery object for the DOM node



    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

  • 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>

  • 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>

  • Initialize the component's attrs.

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


    • attrs: unknown

    Returns void

Generated using TypeDoc v0.23.24