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.


Type Parameters




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.

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.

user: null | User = null

The user this page is for.


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

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


    • username: string

    Returns void

  • 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