Expand all

icons

Constructor

new icons() #

A set of shared icons.

Factory methods are used to keep separate features that use the same icons from accidentally manipulating one another's DOM when calling methods like remove.

Source:
A set of shared icons.

Methods

back() → {IconButton} #

Gets a back icon

The icon should be used to inform the user that the front-end is communicating with the back-end.

Source:

Returns:

Type
IconButton

Gets a back icon

The icon should be used to inform the user that the front-end is communicating with the back-end.

cancel([variant], [props]) → {IconButton} #

Gets a cancel icon

The icon should be used to inform the user that the front-end is communicating with the back-end.

Parameters:

Name Type Attributes Description
variant string optional
props Object optional

to extend

Source:

Returns:

Type
IconButton

Gets a cancel icon

The icon should be used to inform the user that the front-end is communicating with the back-end.

error() → {IconButton} #

Gets a failure (error) icon

Source:

Returns:

Type
IconButton
Gets a failure (error) icon

spinner([props]) → {IconButton} #

Gets a spinner icon. This uses IconButton but should never actually be a button or have full button styles, as its purely presentational

The icon should be used to inform the user that the front-end is communicating with the back-end.

Parameters:

Name Type Attributes Description
props Object optional

See Icon for more details

Source:

Returns:

Type
IconButton
Gets a spinner icon.

watch(props) → {IconButton} #

Gets a non-filled watch star icon.

Parameters:

Name Type Description
props Object
Source:

Returns:

Type
IconButton
Gets a non-filled watch star icon.

watched(props) → {IconButton} #

Gets a filled watch star icon.

Parameters:

Name Type Description
props Object
Source:

Returns:

Type
IconButton
Gets a filled watch star icon.