Reference Source
import LogInModal from 'flarum/components/LogInModal'
public class | source

LogInModal

Extends:

ComponentModal → LogInModal

The LogInModal component displays a modal dialog with a login form.

Props

  • identification
  • password

Member Summary

Public Members
public

The value of the identification input.

public
public

The value of the password input.

public

The value of the remember me input.

Method Summary

Public Methods
public
public
public
public

fields(): *

public
public

Open the forgot password modal, prefilling it with an email if the user has entered one.

public

init()

public

onerror(error: *)

public
public

onsubmit(e: *)

public

signUp()

Open the sign up modal, prefilling it with an email/username/password if the user has entered one.

public

title(): *

Inherited Summary

From class Component
public static

component(props: Object, children: *): Object

Get a Mithril component object for this component, preloaded with props.

public static

initProps(props: Object)

Initialize the component's props.

public

element: *

The root DOM element for the component.

public

The properties passed into the component.

public

Whether or not to retain the component's subtree on redraw.

public

$(selector: String): jQuery

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.

public

config(isInitialized: Boolean, context: Object, vdom: Object)

Called after the component's root element is redrawn. This hook can be used to perform any actions on the DOM, both on the initial draw and any subsequent redraws. See Mithril's documentation for more information.

public

Called when the component is destroyed, i.e.

public

Get the renderable virtual DOM that represents the component's view.

This should NOT be overridden by subclasses. Subclasses wishing to define their virtual DOM should override Component#view instead.

protected

init()

Called when the component is constructed.

protected

Get the virtual DOM that represents the component's view.

From class Modal
public

An alert component to show below the header.

public
public abstract

Get the class name to apply to the modal.

public abstract

content(): VirtualElement

Get the content of the modal.

public

hide()

Hide the modal.

public

init()

public

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

public

loaded()

Stop loading.

public

Show an alert describing an error returned from the API, and give focus to the first relevant field.

public

onhide()

public

Focus on the first input when the modal is ready to be used.

public

onsubmit(e: Event)

Handle the modal form's submit event.

public abstract

Get the title of the modal dialog.

public

view(): *

Public Members

public identification: Function source

The value of the identification input.

public loading: boolean source

Override:

Modal#loading

public password: Function source

The value of the password input.

public remember: Function source

The value of the remember me input.

Public Methods

public body(): undefined[] source

Return:

undefined[]

public className(): string source

Get the class name to apply to the modal.

Override:

Modal#className

Return:

string

public content(): undefined[] source

Get the content of the modal.

Override:

Modal#content

Return:

undefined[]

public fields(): * source

Return:

*

Return:

undefined[]

public forgotPassword() source

Open the forgot password modal, prefilling it with an email if the user has entered one.

public init() source

Called when the component is constructed.

Override:

Modal#init

public onerror(error: *) source

Show an alert describing an error returned from the API, and give focus to the first relevant field.

Override:

Modal#onerror

Params:

NameTypeAttributeDescription
error *

public onready() source

Focus on the first input when the modal is ready to be used.

Override:

Modal#onready

public onsubmit(e: *) source

Handle the modal form's submit event.

Override:

Modal#onsubmit

Params:

NameTypeAttributeDescription
e *

public signUp() source

Open the sign up modal, prefilling it with an email/username/password if the user has entered one.

public title(): * source

Get the title of the modal dialog.

Override:

Modal#title

Return:

*