Class UserPage<CustomAttrs, CustomState>

The UserPage component shows a user's profile. It can be extended to show content inside of the content area. See ActivityPage and SettingsPage for examples.

Abstract

Type Parameters

Hierarchy

Constructors

constructor

Properties

attrs bodyClass element scrollTopOnCreate state useBrowserScrollRestoration user

Methods

$ content loadUser navItems onbeforeremove onbeforeupdate oncreate oninit onremove onupdate show sidebarItems view component initAttrs

Constructors

constructor

Properties

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.

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.

state

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.

Protected useBrowserScrollRestoration

useBrowserScrollRestoration: boolean = true

Whether the browser should restore scroll state on refreshes.

user

user: null | User = null

The user this page is for.

Methods

$

  • $(selector?: string): JQuery<HTMLElement>

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

    Returns

    the jQuery object for the DOM node

    Final

    Parameters

    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

content

loadUser

  • Given a username, load the user's profile from the store, or make a request if we don't have it yet. Then initialize the profile page with that user.

    Parameters

    • username: string

    Returns void

navItems

onbeforeremove

onbeforeupdate

oncreate

oninit

onremove

onupdate

Protected show

sidebarItems

view

Static component

Static initAttrs

  • Initialize the component's attrs.

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

    Parameters

    • attrs: unknown

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc v0.23.24