@types/mithril

property class

class?: string | undefined;

• The class name(s) for this virtual element, as a space-separated list.

property className

className?: string | undefined;

• The class name(s) for this virtual element, as a space-separated list.

index signature

[property: string]: any;

• Any other virtual element properties, including attributes and event handlers.

method onbeforeremove

onbeforeremove: (vnode: VnodeDOM<A, this>) => Promise<any> | void;

• The onbeforeremove hook is called before a DOM element is detached from the document. If a Promise is returned, Mithril only detaches the DOM element after the promise completes.

method onbeforeupdate

onbeforeupdate: (
    vnode: Vnode<A, this>,
    old: VnodeDOM<A, this>
) => boolean | void;

• The onbeforeupdate hook is called before a vnode is diffed in a update.

method oncreate

oncreate: (vnode: VnodeDOM<A, this>) => any;

• The oncreate hook is called after a DOM element is created and attached to the document.

method oninit

oninit: (vnode: Vnode<A, this>) => any;

• The oninit hook is called before a vnode is touched by the virtual DOM engine.

method onremove

onremove: (vnode: VnodeDOM<A, this>) => any;

• The onremove hook is called before a DOM element is removed from the document.

method onupdate

onupdate: (vnode: VnodeDOM<A, this>) => any;

• The onupdate hook is called after a DOM element is updated, while attached to the document.

method view

view: (vnode: Vnode<A, this>) => Children | null | void;

• Creates a view out of virtual elements.

property key

key?: string | number | undefined;

• A key to optionally associate with this element.

method onbeforeremove

onbeforeremove: (
    this: State,
    vnode: VnodeDOM<Attrs, State>
) => Promise<any> | void;

• The onbeforeremove hook is called before a DOM element is detached from the document. If a Promise is returned, Mithril only detaches the DOM element after the promise completes.

method onbeforeupdate

onbeforeupdate: (
    this: State,
    vnode: Vnode<Attrs, State>,
    old: VnodeDOM<Attrs, State>
) => boolean | void;

• The onbeforeupdate hook is called before a vnode is diffed in a update.

method oncreate

oncreate: (this: State, vnode: VnodeDOM<Attrs, State>) => any;

• The oncreate hook is called after a DOM element is created and attached to the document.

method oninit

oninit: (this: State, vnode: Vnode<Attrs, State>) => any;

• The oninit hook is called before a vnode is touched by the virtual DOM engine.

method onremove

onremove: (this: State, vnode: VnodeDOM<Attrs, State>) => any;

• The onremove hook is called before a DOM element is removed from the document.

method onupdate

onupdate: (this: State, vnode: VnodeDOM<Attrs, State>) => any;

• The onupdate hook is called after a DOM element is updated, while attached to the document.

method onbeforeremove

onbeforeremove: (
    this: _NoLifecycle<this & State>,
    vnode: VnodeDOM<Attrs, _NoLifecycle<this & State>>
) => Promise<any> | void;

• The onbeforeremove hook is called before a DOM element is detached from the document. If a Promise is returned, Mithril only detaches the DOM element after the promise completes.

method onbeforeupdate

onbeforeupdate: (
    this: _NoLifecycle<this & State>,
    vnode: Vnode<Attrs, _NoLifecycle<this & State>>,
    old: VnodeDOM<Attrs, _NoLifecycle<this & State>>
) => boolean | void;

• The onbeforeupdate hook is called before a vnode is diffed in a update.

method oncreate

oncreate: (
    this: _NoLifecycle<this & State>,
    vnode: VnodeDOM<Attrs, _NoLifecycle<this & State>>
) => any;

• The oncreate hook is called after a DOM element is created and attached to the document.

method oninit

oninit: (
    this: _NoLifecycle<this & State>,
    vnode: Vnode<Attrs, _NoLifecycle<this & State>>
) => any;

• The oninit hook is called before a vnode is touched by the virtual DOM engine.

method onremove

onremove: (
    this: _NoLifecycle<this & State>,
    vnode: VnodeDOM<Attrs, _NoLifecycle<this & State>>
) => any;

• The onremove hook is called before a DOM element is removed from the document.

method onupdate

onupdate: (
    this: _NoLifecycle<this & State>,
    vnode: VnodeDOM<Attrs, _NoLifecycle<this & State>>
) => any;

• The onupdate hook is called after a DOM element is updated, while attached to the document.

method view

view: (
    this: _NoLifecycle<this & State>,
    vnode: Vnode<Attrs, _NoLifecycle<this & State>>
) => Children | null | void;

• Creates a view out of virtual elements.

method fragment

fragment: (
    attrs: CommonAttributes<any, any> & { [key: string]: any },
    children: ChildArrayOrPrimitive
) => Vnode<any, any>;

• Creates a fragment virtual element (Vnode).

method trust

trust: (html: string) => Vnode<any, any>;

• Turns an HTML string into a virtual element (Vnode). Do not use trust on unsanitized user input.

call signature

<Attrs, State>(
    component: ComponentTypes<Attrs, State>,
    attributes: Attrs & CommonAttributes<Attrs, State>,
    ...args: Children[]
): Vnode<Attrs, State>;

• Creates a virtual element (Vnode).

call signature

(selector: string, attributes: Attributes, ...children: Children[]): Vnode<
    any,
    any
>;

• Creates a virtual element (Vnode).

call signature

<Attrs, State>(
    component: ComponentTypes<Attrs, State>,
    ...args: Children[]
): Vnode<Attrs, State>;

• Creates a virtual element (Vnode).

call signature

(selector: string, ...children: Children[]): Vnode<any, any>;

• Creates a virtual element (Vnode).

property background

background?: boolean | undefined;

• If false, redraws mounted components upon completion of the request. If true, it does not.

property body

body?: any;

• The data to be serialized into the request body.

property callbackKey

callbackKey?: string | undefined;

• The name of the querystring parameter name that specifies the callback name.

property callbackName

callbackName?: string | undefined;

• The name of the function that will be called as the callback.

property params

params?: { [id: string]: any } | undefined;

• The data to be interpolated into the URL and serialized into the querystring.

property type

type?: new (o: any) => any;

• A constructor to be applied to each object in the response.

index signature

[key: string]: string | number | boolean | null | undefined | Params;

method sync

sync: () => void;

• Manually triggers a synchronous redraw of mounted components.

call signature

(): void;

• Manually triggers an asynchronous redraw of mounted components.

property async

async?: boolean | undefined;

• Whether the request should be asynchronous. Defaults to true.

property background

background?: boolean | undefined;

• If false, redraws mounted components upon completion of the request. If true, it does not.

property body

body?:
    | (XMLHttpRequest['send'] extends (x: infer R) => any ? R : never)
    | (object & { [id: string]: any })
    | undefined;

• The data to be serialized into the request body.

property headers

headers?: { [key: string]: string } | undefined;

• Headers to append to the request before sending it.

property method

method?: string | undefined;

• The HTTP method to use.

property params

params?: { [key: string]: any } | undefined;

• The data to be interpolated into the URL and serialized into the querystring.

property password

password?: string | undefined;

• A password for HTTP authorization.

property responseType

responseType?:
    | ''
    | 'arraybuffer'
    | 'blob'
    | 'document'
    | 'json'
    | 'text'
    | undefined;

• The expected type of the response, as a legal value of XMLHttpRequest.responseType.

property timeout

timeout?: number | undefined;

• Milliseconds a request can take before automatically being terminated.

property type

type?: new (o: any) => any;

• A constructor to be applied to each object in the response.

property useBody

useBody?: boolean | undefined;

• Force the use of the HTTP body section for data in GET requests when set to true, or the use of querystring for other HTTP methods when set to false. Defaults to false for GET requests and true for other methods.

property user

user?: string | undefined;

• A username for HTTP authorization.

property withCredentials

withCredentials?: boolean | undefined;

• Whether to send cookies to 3rd party domains.

method config

config: (xhr: XMLHttpRequest, options: this) => XMLHttpRequest | void;

• Exposes the underlying XMLHttpRequest object for low-level configuration.

method deserialize

deserialize: (data: string) => T;

• A deserialization method to be applied to the response. Defaults to a small wrapper around JSON.parse that returns null for empty responses.

method extract

extract: (xhr: XMLHttpRequest, options: this) => T;

• A hook to specify how the XMLHttpRequest response should be read. Useful for reading response headers and cookies. Defaults to a function that returns xhr.responseText

method serialize

serialize: (data: any) => any;

• A serialization method to be applied to data. Defaults to JSON.stringify, or if options.data is an instance of FormData, defaults to the identity function.

property Link

Link: Component<RouteLinkAttrs>;

• This Component renders a link <a href> that will use the current routing strategy

property prefix

prefix: string;

• Defines a router prefix which is a fragment of the URL that dictates the underlying strategy used by the router.

method get

get: () => string;

• Returns the last fully resolved routing path, without the prefix.

method param

param: { (name: string): string; (): any };

• Returns the named parameter value from the current route.

• Gets all route parameters.

method set

set: (route: string, data?: any, options?: RouteOptions) => void;

• Redirects to a matching route or to the default route if no matching routes can be found.

call signature

(element: Element, defaultRoute: string, routes: RouteDefs): void;

• Creates application routes and mounts Components and/or RouteResolvers to a DOM element.

index signature

[url: string]: ComponentTypes<any, any> | RouteResolver<any, any>;

• The key represents the route. The value represents the corresponding component.

property href

href: string;

property options

options?: RouteOptions | undefined;

property selector

selector?: string | ComponentTypes<any> | undefined;

property replace

replace?: boolean | undefined;

• Routing parameters. If path has routing parameter slots, the properties of this object are interpolated into the path string.

property state

state?: any;

• The state object to pass to the underlying history.pushState / history.replaceState call.

property title

title?: string | undefined;

• The title string to pass to the underlying history.pushState / history.replaceState call.

method onmatch

onmatch: (
    this: this,
    args: Attrs,
    requestedPath: string,
    route: string
) => ComponentTypes<any, any> | Promise<any> | void;

• The onmatch hook is called when the router needs to find a component to render.

method render

render: (this: this, vnode: Vnode<Attrs, State>) => Children;

• The render method is called on every redraw for a matching route.

property jsonp

jsonp: typeof jsonp;

property mount

mount: typeof mount;

property redraw

redraw: Redraw;

property render

render: typeof render;

property request

request: typeof request;

property route

route: Route;

method buildPathname

buildPathname: (template: string, params?: Params) => string;

• Build path name

method buildQueryString

buildQueryString: (values: Params) => string;

• Turns the key/value pairs of an object into a string of the form: a=1&b=2

method parsePathname

parsePathname: (url: string) => { path: string; params: Params };

• Parse path name

method parseQueryString

parseQueryString: (queryString: string) => Params;

• Returns an object with key/value pairs parsed from a string of the form: ?a=1&b=2

property attrs

attrs: Attrs;

• A hashmap of DOM attributes, events, properties and lifecycle methods.

property children

children?: ChildArrayOrPrimitive | undefined;

• In most vnode types, the children property is an array of vnodes. For text and trusted HTML vnodes, The children property is either a string, a number or a boolean.

property key

key?: string | number | undefined;

• The value used to map a DOM element to its respective item in an array of data.

property state

state: State;

• An object that is persisted between redraws. In component vnodes, state is a shallow clone of the component object.

property tag

tag: string | ComponentTypes<Attrs, State>;

• The nodeName of a DOM element. It may also be the string [ if a vnode is a fragment, # if it's a text vnode, or < if it's a trusted HTML vnode. Additionally, it may be a component.

property text

text?: string | number | boolean | undefined;

• This is used instead of children if a vnode contains a text node as its only child. This is done for performance reasons. Component vnodes never use the text property even if they have a text node as their only child.

property dom

dom: Element;

• Points to the element that corresponds to the vnode.

property domSize

domSize?: number | undefined;

• This defines the number of DOM elements that the vnode represents (starting from the element referenced by the dom property).