Options
All
  • Public
  • Public/Protected
  • All
Menu

The ConfirmDocumentUnload component can be used to register a global event handler that prevents closing the browser window/tab based on the return value of a given callback prop.

Attrs

  • when - a callback returning true when the browser should prompt for confirmation before closing the window/tab

Children

NOTE: Only the first child will be rendered. (Use this component to wrap another component / DOM element.)

Hierarchy

Index

Constructors

constructor

Properties

Protected attrs

The attributes passed into the component.

see

https://mithril.js.org/components.html#passing-data-to-components

boundHandler

boundHandler: undefined | (() => any)

Protected element

element: Element

The root DOM element for the component.

Protected state

state: undefined

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.

Methods

Protected $

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

    final

    Parameters

    • Optional selector: string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

handler

  • handler(): any

onbeforeremove

onbeforeupdate

oncreate

  • oncreate(vnode: any): void

oninit

onremove

  • onremove(vnode: any): void

onupdate

view

  • view(vnode: any): any

Static component

  • component<SAttrs>(attrs?: SAttrs, children?: Children): Vnode<{}, {}>

Static Protected initAttrs

  • initAttrs<T>(attrs: T): void

Generated using TypeDoc version 0.22.10