Class: StatusIndicator

new StatusIndicator(options) → {Class}

A statusIndicator component .

Parameters:

Name Type Description

options

object

The options for the component.

Properties

Name	Type	Description
`customAttributes`	object	Any custom attributes for the component.
`customClasses`	Array	An array of additional classes for the component.
`hasDot`	boolean	Whether or not to include the svg dot.
`id`	string	Id for the component, auto generated if not passed.
`isStatic`	boolean	Whether or not the indicator should be active (`button`) or static (`span`).
`label`	string	Status indicator label.
`pill`	boolean	Whether or not to apply fully rounded "pill" css to the indicator.
`rendered`	string	Is the component already rendered in the dom, eg by php?
`renderOnInit`	string	Render the component on init of the class?
`size`	string	Size of the component.
`spacing`	string	Spacing for the component.
`status`	string	Type of indicator: `active`, `inactive`, or `error`.
`target`	string	The target to render to. Any valid css selector string.
`targetPosition`	string	The insert position for the component relative to the target.
`theme`	string	Theme for the component, primary or cosmos.

Since: 1.1.16
Source: elements/StatusIndicator/index.js, line 90

Returns:

The class instance.

Type:: Class

Example

import StatusIndicator from '@gravityforms/components/html/admin/elements/StatusIndicator';

function Example() {
     const statusIndicatorInstance = new StatusIndicator( {
         id: 'example-statusIndicator',
         renderOnInit: false,
         target: '#example-target',
         targetPosition: 'beforeend',
         theme: 'cosmos',
     } );

     // Some time later we can render it. This is only done if we set renderOnInit to false.
     // If true it will render on initialization.
     statusIndicatorInstance.init();
}

Methods

(static) init() → {void}

Initialize the component.

Since: 1.1.16
Source: elements/StatusIndicator/index.js, line 212

Fires:

event:gform/status_indicator/post_render

Returns:

Type:: void

(static) render() → {void}

Renders the component into the dom.

Since: 1.1.16
Source: elements/StatusIndicator/index.js, line 187

Returns:

Type:: void

(static) statusIndicatorTemplate(options) → {string}

Generates the markup for a statusIndicator in the admin.

Parameters:

Name Type Description

options

object

The options for the component template.

Properties

Name	Type	Description
`customAttributes`	object	Any custom attributes.
`customClasses`	Array	An array of additional classes for the toggle.
`hasDot`	boolean	Whether or not to include the svg dot.
`id`	string	Id for the statusIndicator, auto generated if not passed.
`isStatic`	boolean	Whether or not the indicator should be active (`button`) or static (`span`).
`label`	string	Status indicator label.
`size`	string	The size of the component.
`pill`	boolean	Whether or not to apply fully rounded "pill" css to the indicator.
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`status`	string	Type of indicator: `active`, `inactive`, or `error`.
`theme`	string	Theme for the toggle, primary or cosmos.

Since: 1.1.16
Source: elements/StatusIndicator/index.js, line 10

Returns:

Type:: string

Example

import { statusIndicatorTemplate } from '@gravityforms/components/html/admin/elements/StatusIndicator';

function Example() {
     const statusIndicatorTemplateHTML = statusIndicatorTemplateTemplate( options );
     document.body.insertAdjacentHTML( 'beforeend', statusIndicatorTemplateHTML );
}