Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Modal<ModalAttrs>

The Modal component displays a modal dialog, wrapped in a form. Subclasses should implement the className, title, and content methods.

Type parameters

Hierarchy

Index

Constructors

constructor

  • new Modal<ModalAttrs>(): Modal<ModalAttrs>

Properties

alertAttrs

alertAttrs: null | AlertAttrs = null

Attributes for an alert component to show below the header.

attrs

attrs: ModalAttrs

The attributes passed into the component.

see

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

element

element: Element

The root DOM element for the component.

Protected loading

loading: boolean = false

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.

Static Readonly isDismissible

isDismissible: boolean = true

Determine whether or not the modal should be dismissible via an 'x' button.

deprecated

Use the individual isDismissibleVia... attributes instead and remove references to this.

Static Protected Readonly isDismissibleViaBackdropClick

isDismissibleViaBackdropClick: boolean = true

Can the modal be dismissed via a click on the backdrop.

Static Protected Readonly isDismissibleViaCloseButton

isDismissibleViaCloseButton: boolean = true

Can the model be dismissed with a close button (X)?

If false, no close button is shown.

Static Protected Readonly isDismissibleViaEscKey

isDismissibleViaEscKey: boolean = true

Can the modal be dismissed by pressing the Esc key on a keyboard?

Accessors

Private dismissibleOptions

Static dismissibleOptions

Methods

$

  • 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

Abstract className

  • className(): string

Abstract content

  • content(): Children

hide

  • hide(): void

loaded

  • loaded(): void

onbeforeremove

  • onbeforeremove(vnode: VnodeDOM<ModalAttrs, Modal<ModalAttrs>>): void | Promise<void>

onbeforeupdate

  • onbeforeupdate(vnode: VnodeDOM<ModalAttrs, Modal<ModalAttrs>>): void

oncreate

  • oncreate(vnode: VnodeDOM<ModalAttrs, Modal<ModalAttrs>>): void

onerror

oninit

  • oninit(vnode: Vnode<ModalAttrs, Modal<ModalAttrs>>): void

onready

  • onready(): void
  • Callback executed when the modal is shown and ready to be interacted with.

    remark

    Focuses the first input in the modal.

    Returns void

onremove

  • onremove(vnode: VnodeDOM<ModalAttrs, Modal<ModalAttrs>>): void

onsubmit

  • onsubmit(e: SubmitEvent): void

onupdate

  • onupdate(vnode: VnodeDOM<ModalAttrs, Modal<ModalAttrs>>): void

Abstract title

  • title(): Children

view

  • view(): Element

Static component

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

Static initAttrs

  • initAttrs(attrs: unknown): void

Generated using TypeDoc version 0.22.10