Class: ApiButton

The ApiButton is a button that opens a popper element with possible actions.

Dependencies: the system uses functions of the monsterjs library as well as pooperjs.

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

<monster-action-button></monster-action-button>

Or you can create this CustomControl directly in Javascript:

import {PopperButton} from '@schukai/component-form/source/action-button.js';
document.createElement('monster-action-button');

The data-monster-button-class attribute can be used to change the CSS class of the button.

Constructor

new ApiButton()

A button that opens a popper element with possible actions.

Since: 3.32.0
Copyright: schukai GmbH

Fires:

Members

defaults

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

Properties

Name Type Description

mapping

object

The mapping object.

Properties

Name	Type	Description
`selector`	string	The selector to find the buttons in the response.
`labelSelector`	string	The selector to find the label for the button.
`labelTemplate`	string	The template to create the label for the button.
`apiTemplate`	string	The template to create the api for the button.
`urlTemplate`	string	The template to create the url for the button.
`filter`	function	The filter function to filter the buttons.

url

string

The url to fetch the data.

api

object

The api options.

Properties

Name	Type	Description
`fetch`	object	The fetch options.
`body`	string	The body template.

callbacks

object

The callbacks object.

Properties

Name	Type	Description
`beforeApi`	function	The beforeApi callback.

fetch

object

The fetch options.

Properties

Name Type Description

redirect

string

The redirect option.

method

string

The method option.

mode

string

The mode option.

credentials

string

The credentials option.

headers

object

The headers option.

Properties

Name	Type	Description
`accept`	string	The accept option.

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.

Methods

assembleMethodSymbol() → {Monster.Components.Form.Popper}

Returns:

Type:: Monster.Components.Form.Popper

fetch() → {Promise}

Returns:

Type:: Promise

importButtons(data) → {Monster.Components.Form.ApiButton}

Import buttons from a map.

Parameters:

Name	Type	Description
`data`	array \| object \| Map \| Set

Since: 0.16.0

Throws:

map is not iterable
Type
Error
missing label configuration
Type
Error

Returns:

Type:: Monster.Components.Form.ApiButton

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

Returns:

Type:: Array.<CSSStyleSheet>

(static) getTag() → {string}

Returns:

Type:: string