Class DefaultResolver<Attrs, Comp, 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 ComponentAttrs
Comp extends Component<Attrs & {
routeName: string;
}>
RouteArgs extends Record<string, unknown> = {}

Hierarchy

DefaultResolver
- ExtensionPageResolver
- DiscussionPageResolver

Implements

RouteResolver<Attrs, Comp, RouteArgs>

Index

Constructors

constructor

new DefaultResolver<Attrs, Comp, RouteArgs>(component: (new () => Comp), routeName: string): DefaultResolver<Attrs, Comp, RouteArgs>
Type Parameters
- Attrs extends ComponentAttrs<Attrs>
- Comp extends Component<Attrs & {
  routeName: string;
  }, undefined, Comp>
- RouteArgs extends Record<string, unknown> = {}
Parameters
- component: (new () => Comp)
  - - new (): Comp
    - Returns Comp
- routeName: string
Returns DefaultResolver<Attrs, Comp, RouteArgs>
- Defined in src/common/resolvers/DefaultResolver.ts:21

Properties

component

component: (new () => Comp)

Type declaration

- new (): Comp
- Returns Comp

routeName

routeName: string

Methods

makeAttrs

makeAttrs(vnode: Vnode<Attrs, Comp>): Attrs & {
routeName: string;
}
Parameters
- vnode: Vnode<Attrs, Comp>
Returns Attrs & {
routeName: string;
}
- Defined in src/common/resolvers/DefaultResolver.ts:35

makeKey

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

Returns string
- Defined in src/common/resolvers/DefaultResolver.ts:31

onmatch

onmatch(args: RouteArgs, requestedPath: string, route: string): (new () => Comp)
A method which selects which component to render based on conditional logic.

Returns the component class, and not a Vnode or JSX expression.

See
https://mithril.js.org/route.html#routeresolveronmatch
Parameters
- args: RouteArgs
- requestedPath: string
- route: string
Returns (new () => Comp)
- - new (): Comp
  - Returns Comp
Implementation of RouteResolver.onmatch
- Defined in src/common/resolvers/DefaultResolver.ts:42

render

render(vnode: Vnode<Attrs, Comp>): 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.

See
https://mithril.js.org/route.html#routeresolverrender
Parameters
- vnode: Vnode<Attrs, Comp>
Returns Children
Implementation of RouteResolver.render
- Defined in src/common/resolvers/DefaultResolver.ts:46

Class DefaultResolver<Attrs, Comp, RouteArgs>

Type Parameters

Attrs extends ComponentAttrs

Comp extends Component<Attrs & { routeName: string; }>

RouteArgs extends Record<string, unknown> = {}

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Attrs extends ComponentAttrs<Attrs>

Comp extends Component<Attrs & { routeName: string; }, undefined, Comp>

RouteArgs extends Record<string, unknown> = {}

Parameters

component: (new () => Comp)

Returns Comp

routeName: string

Returns DefaultResolver<Attrs, Comp, RouteArgs>

Properties

component

Type declaration

Returns Comp

routeName

Methods

makeAttrs

Parameters

vnode: Vnode<Attrs, Comp>

Returns Attrs & { routeName: string; }

makeKey

Returns string

onmatch

See

Parameters

args: RouteArgs

requestedPath: string

route: string

Returns (new () => Comp)

Returns Comp

render

See

Parameters

vnode: Vnode<Attrs, Comp>

Returns Children

Settings

Member Visibility

Theme

Comp extends Component<Attrs & {
routeName: string;
}>

Comp extends Component<Attrs & {
routeName: string;
}, undefined, Comp>

Returns Attrs & {
routeName: string;
}