Class: MessageStateButton

Monster .Components .Form. MessageStateButton

This CustomControl creates a button element with a variety of options.

Dependencies: the system uses functions of the monsterjs library

You can create this control either by specifying the HTML tagdirectly in the HTML or using Javascript via thedocument.createElement('monster-message-state-button');` method.

<monster-message-state-button></monster-message-state-button>

Or you can create this CustomControl directly in Javascript:

import from '@schukai/monster/source/components/form/message-state-button.mjs';
document.createElement('monster-state-button');

Constructor

new MessageStateButton()

A state button with icons and a message

Since: 2.11.0
Copyright: schukai GmbH

Members

defaults

To set the options via the html tag the attribute data-monster-options must be used.

Properties

Name Type Description

templates

Object

Template definitions

Properties

Name	Type	Description
`main`	string	Main template

labels

Object

Label definitions

Properties

Name	Type	Description
`button`	string	Button label

mode

Object

Mode definitions (manual, submit)

See: https://monsterjs.org/en/doc/#configurate-a-monster-control The individual configuration values can be found in the table.

(static) instanceSymbol

This method is called by the instanceof operator.

Since: 2.1.0

Methods

assembleMethodSymbol()

blur()

The Button.blur() method removes focus from the internal button element.

click()

The Button.click() method simulates a click on the internal button element.

Since: 3.27.0
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click

focus(options)

The Button.focus() method sets focus on the internal button element.

Parameters:

Name	Type	Description
`options`	Object

Since: 3.27.0
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus

getMessage() → {Object}

Returns:

Type:: Object

getState() → {Monster.Components.Form.Types.State|undefined}

Returns:

Type:: Monster.Components.Form.Types.State | undefined

hideMessage() → {Monster.Components.Form.MessageStateButton}

Returns:

Type:: Monster.Components.Form.MessageStateButton

removeState() → {Monster.Components.Form.MessageStateButton}

Returns:

Type:: Monster.Components.Form.MessageStateButton

setMessage(message, title, icon) → {Monster.Components.Form.MessageStateButton}

Sets the message

Parameters:

Name	Type	Description
`message`	string \| HTMLElement
`title`	string
`icon`	string

Returns:

Type:: Monster.Components.Form.MessageStateButton

setState(state, timeout) → {Monster.Components.Form.MessageStateButton}

Parameters:

Name	Type	Description
`state`	string
`timeout`	number

Throws:

value is not a string
Type
TypeError
value is not an instance
Type
TypeError

Returns:

Type:: Monster.Components.Form.MessageStateButton

showMessage(timeout) → {Monster.Components.Form.MessageStateButton}

Parameters:

Name	Type	Description
`timeout`	number

Returns:

Type:: Monster.Components.Form.MessageStateButton

toggleMessage() → {Monster.Components.Form.MessageStateButton}

Returns:

Type:: Monster.Components.Form.MessageStateButton

(static) getCSSStyleSheet() → {Array.<CSSStyleSheet>}

Returns:

Type:: Array.<CSSStyleSheet>

(static) getTag() → {string}

Returns:

Type:: string