Class UserPageResolver<Attrs, RouteArgs>

Generates a route resolver for a given component.

In addition to regular route resolver functionality:

It provide the current route name as an attr
It sets a key on the component so a rerender will be triggered on route change.

Type Parameters

Attrs extends IUserPageAttrs = IUserPageAttrs
RouteArgs extends Record<string, unknown> = {}

Hierarchy (View Summary)

DefaultResolver<Attrs, UserPage<Attrs>, RouteArgs>
- UserPageResolver

Index

Constructors

Properties

component routeName

Methods

canonicalizeUserSlug makeAttrs makeKey onmatch render

Constructors

constructor

new UserPageResolver<
    Attrs extends IUserPageAttrs = IUserPageAttrs,
    RouteArgs extends Record<string, unknown> = {},
>(
    component:
        | NewComponent<UserPage<Attrs, undefined>>
        | AsyncNewComponent<UserPage<Attrs, undefined>>,
    routeName: string,
): UserPageResolver<Attrs, RouteArgs>
Type Parameters
- Attrs extends IUserPageAttrs = IUserPageAttrs
- RouteArgs extends Record<string, unknown> = {}
Parameters
- component:
  | NewComponent<UserPage<Attrs, undefined>>
  | AsyncNewComponent<UserPage<Attrs, undefined>>
- routeName: string
Returns UserPageResolver<Attrs, RouteArgs>
Inherited from DefaultResolver.constructor
- Defined in flarum/framework/core/js/src/common/resolvers/DefaultResolver.tsx:22

Properties

component

component:
| NewComponent<UserPage<Attrs, undefined>>
| AsyncNewComponent<UserPage<Attrs, undefined>>

routeName

routeName: string

Methods

canonicalizeUserSlug

canonicalizeUserSlug(slug: string | undefined): string | undefined
Parameters
- slug: string | undefined
Returns string | undefined
- Defined in flarum/framework/core/js/src/forum/resolvers/UserPageResolver.ts:12

makeAttrs

makeAttrs(
vnode: Vnode<Attrs, UserPage<Attrs, undefined>>,
): Attrs & { routeName: string }
Parameters
- vnode: Vnode<Attrs, UserPage<Attrs, undefined>>
Returns Attrs & { routeName: string }
Inherited from DefaultResolver.makeAttrs
- Defined in flarum/framework/core/js/src/common/resolvers/DefaultResolver.tsx:36

makeKey

makeKey(): string
When a route change results in a changed key, a full page rerender occurs. This method can be overridden in subclasses to prevent rerenders on some route changes.

Returns string
Overrides DefaultResolver.makeKey
- Defined in flarum/framework/core/js/src/forum/resolvers/UserPageResolver.ts:17

onmatch

onmatch(
    args: RouteArgs,
    requestedPath: string,
    route: string,
): Promise<NewComponent<UserPage<Attrs, undefined>>>
A method which selects which component to render based on conditional logic.

Returns the component class, and not a Vnode or JSX expression.
Parameters
- args: RouteArgs
- requestedPath: string
- route: string
Returns Promise<NewComponent<UserPage<Attrs, undefined>>>
See
https://mithril.js.org/route.html#routeresolveronmatch
Inherited from DefaultResolver.onmatch
- Defined in flarum/framework/core/js/src/common/resolvers/DefaultResolver.tsx:43

render

render(vnode: Vnode<Attrs, UserPage<Attrs, undefined>>): Children
A function which renders the provided component.

If not specified, the route will default to rendering the component on its own, inside of a fragment.

Returns a Mithril Vnode or other children.
Parameters
- vnode: Vnode<Attrs, UserPage<Attrs, undefined>>
Returns Children
See
https://mithril.js.org/route.html#routeresolverrender
Overrides DefaultResolver.render
- Defined in flarum/framework/core/js/src/forum/resolvers/UserPageResolver.ts:23