Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChangeEmailModal<CustomAttrs>

The ChangeEmailModal component shows a modal dialog which allows the user to change their email address.

Type parameters

Hierarchy

  • Modal<CustomAttrs>
    • ChangeEmailModal

Index

Constructors

constructor

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.

email

email: Stream<string>

The value of the email input.

Protected loading

loading: boolean = false

password

password: Stream<string>

The value of the password input.

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.

success

success: boolean = false

Whether or not the email has been changed successfully.

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

className

  • className(): string

content

  • content(): Element

hide

  • hide(): void

loaded

  • loaded(): void

onbeforeremove

onbeforeupdate

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

oncreate

onerror

oninit

onready

  • onready(): void

onremove

onsubmit

  • onsubmit(e: SubmitEvent): void

onupdate

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