Class ExtensionPageResolver<Attrs, RouteArgs>

A custom route resolver for ExtensionPage that generates handles routes to default extension pages or a page provided by an extension.

Type Parameters

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

Hierarchy

DefaultResolver<Attrs, ExtensionPage<Attrs>, RouteArgs>
- ExtensionPageResolver

Index

Constructors

constructor

new ExtensionPageResolver<Attrs, RouteArgs>(component: (new () => ExtensionPage<Attrs>), routeName: string): ExtensionPageResolver<Attrs, RouteArgs>
Type Parameters
- Attrs extends ExtensionPageAttrs = ExtensionPageAttrs
- RouteArgs extends Record<string, unknown> = {}
Parameters
- component: (new () => ExtensionPage<Attrs>)
  - - new (): ExtensionPage<Attrs>
    - Returns ExtensionPage<Attrs>
- routeName: string
Returns ExtensionPageResolver<Attrs, RouteArgs>
Inherited from DefaultResolver.constructor
- Defined in src/common/resolvers/DefaultResolver.ts:21

Properties

component

component: (new () => ExtensionPage<Attrs>)

Type declaration

- new (): ExtensionPage<Attrs>
- Returns ExtensionPage<Attrs>

routeName

routeName: string

`Static` extension

extension: null | string = null

Methods

makeAttrs

makeAttrs(vnode: Vnode<Attrs, ExtensionPage<Attrs>>): Attrs & {
routeName: string;
}
Parameters
- vnode: Vnode<Attrs, ExtensionPage<Attrs>>
Returns Attrs & {
routeName: string;
}
Inherited from DefaultResolver.makeAttrs
- 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
Inherited from DefaultResolver.makeKey
- Defined in src/common/resolvers/DefaultResolver.ts:31

onmatch

onmatch(args: Attrs & RouteArgs, requestedPath: string, route: string): CustomExtensionPage<Attrs>
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: Attrs & RouteArgs
- requestedPath: string
- route: string
Returns CustomExtensionPage<Attrs>
Overrides DefaultResolver.onmatch
- Defined in src/admin/resolvers/ExtensionPageResolver.ts:15

render

render(vnode: Vnode<Attrs, ExtensionPage<Attrs>>): 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, ExtensionPage<Attrs>>
Returns Children
Inherited from DefaultResolver.render
- Defined in src/common/resolvers/DefaultResolver.ts:46

Class ExtensionPageResolver<Attrs, RouteArgs>

Type Parameters

Attrs extends ExtensionPageAttrs = ExtensionPageAttrs

RouteArgs extends Record<string, unknown> = {}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Attrs extends ExtensionPageAttrs = ExtensionPageAttrs

RouteArgs extends Record<string, unknown> = {}

Parameters

component: (new () => ExtensionPage<Attrs>)

Returns ExtensionPage<Attrs>

routeName: string

Returns ExtensionPageResolver<Attrs, RouteArgs>

Properties

component

Type declaration

Returns ExtensionPage<Attrs>

routeName

Static extension

Methods

makeAttrs

Parameters

vnode: Vnode<Attrs, ExtensionPage<Attrs>>

Returns Attrs & { routeName: string; }

makeKey

Returns string

onmatch

See

Parameters

args: Attrs & RouteArgs

requestedPath: string

route: string

Returns CustomExtensionPage<Attrs>

render

See

Parameters

vnode: Vnode<Attrs, ExtensionPage<Attrs>>

Returns Children

Settings

Member Visibility

Theme

`Static` extension

Returns Attrs & {
routeName: string;
}