Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReadmeModal<CustomAttrs>

Type parameters

Hierarchy

  • Modal<CustomAttrs>
    • ReadmeModal

Index

Constructors

constructor

  • new ReadmeModal<CustomAttrs>(): ReadmeModal<CustomAttrs>

Properties

alertAttrs

alertAttrs: null | AlertAttrs = null

Attributes for an alert component to show below the header.

attrs

attrs: CustomAttrs

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 extName

extName: string

Protected loading

loading: boolean = false

Protected name

name: string

Protected readme

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.

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

className

  • className(): string

content

  • content(): Element

hide

  • hide(): void

loadReadme

loaded

  • loaded(): void

onbeforeremove

  • onbeforeremove(vnode: VnodeDOM<CustomAttrs, ReadmeModal<CustomAttrs>>): void | Promise<void>

onbeforeupdate

  • onbeforeupdate(vnode: VnodeDOM<CustomAttrs, ReadmeModal<CustomAttrs>>): void

oncreate

  • oncreate(vnode: VnodeDOM<CustomAttrs, ReadmeModal<CustomAttrs>>): void

onerror

oninit

  • oninit(vnode: Vnode<CustomAttrs, ReadmeModal<CustomAttrs>>): void

onready

  • onready(): void

onremove

  • onremove(vnode: VnodeDOM<CustomAttrs, ReadmeModal<CustomAttrs>>): void

onsubmit

  • onsubmit(e: SubmitEvent): void

onupdate

  • onupdate(vnode: VnodeDOM<CustomAttrs, ReadmeModal<CustomAttrs>>): void

title

view

  • view(): Element

Static component

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

Static initAttrs

  • initAttrs(attrs: unknown): void
  • Initialize the component's attrs.

    This can be used to assign default values for missing, optional attrs.

    Parameters

    • attrs: unknown

    Returns void

Generated using TypeDoc version 0.22.10