Global

Methods

alertTemplate(options) → {string}

Generates the markup for an alert in the admin.

Parameters:

Name Type Description

options

object

The options for the component template.

Properties

Name	Type	Description
`content`	string	The content of the alert.
`ctaLabel`	string	The label for the call-to-action button.
`ctaLink`	string	The link href for the call-to-action button.
`customAttributes`	object	Any custom attributes.
`customClasses`	Array	An array of additional classes for the toggle.
`dismissableAriaLabel`	string	The aria-label for the dismiss button.
`dismissableTitle`	string	The title for the dismiss button.
`hasCta`	boolean	Whether or not the alert has a call-to-action button.
`id`	string	Id for the alert, auto generated if not passed.
`isDismissable`	boolean	Whether or not the alert is dismissable.
`isInline`	boolean	Whether or not the alert is inline.
`selector`	string	The data-js selector string for the alert.
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`theme`	string	Theme for the toggle, primary or cosmos.
`type`	string	The type of the alert. Default, notice, success, error and accessibility.

Since: 1.1.16
Source: elements/Alert/index.js, line 13

Returns:

Type:: string

Example

import { alertTemplate } from '@gravityforms/components/html/admin/elements/Alert';

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

bindEvents()

Bind event handlers

Source: modules/SnackBar/index.js, line 179

buttonTemplate(options) → {string}

The template function used to generate our button html.

Parameters:

Name Type Description

options

object

The options object for the class.

Properties

Name	Type	Description
`activeText`	string	If interactive, what is the active text when the button is active?
`activeType`	string	What is the active type? Supports loading currently.
`attributes`	string	Arbitrary attributes for the button.
`customClasses`	Array	Custom classes for the button.
`html`	string	Arbitrary html to append inside the button.
`icon`	string	Icon name if wishing to use an icon button.
`iconPosition`	string	Icon position if using one. leading or trailing.
`id`	string	Id for the button.
`interactive`	boolean	Is the button interactive? If true the button has two states it transitions, set by activeType.
`label`	string	The label for the button. If interactive, the text displayed when inactive.
`round`	boolean	Does the button have round corners?
`size`	string	Size of the button.
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`type`	string	The button type.

Since: 1.0.5
Source: elements/Button/index.js, line 13

Returns:

The button html.

Type:: string

Example

import { buttonTemplate } from '@gravityforms/components/html/admin/elements/Button';

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

cleanUp()

Clears timeouts and does all needed garbage cleanup.

Source: modules/SnackBar/index.js, line 76

close()

Animates out the snackbar and then removes it from dom.

Source: modules/SnackBar/index.js, line 98

dialogTemplate(options)

The template function that returns html for the dialog. Options below are passed from constructor and described there.

Parameters:

Name Type Description

options

object

The options for the dialog.

Properties

Name	Type	Description
`alertButtonText`	string	The text for the alert button.
`cancelButtonText`	string	The text for the cancel button.
`closeButtonClasses`	string	The classes for the close button. Space seperated string.
`closeButtonAriaLabel`	string	The aria label for the close button.
`closeButtonSize`	string	The size for the close button.
`closeButtonTitle`	string	The title for the close button.
`closeButtonType`	string	The type for the close button.
`confirmButtonAttributes`	string	The attributes for the confirm button. Space seperated string.
`confirmButtonIcon`	string	The icon for the confirm button.
`confirmButtonText`	string	The text for the confirm button.
`content`	string	The content for the dialog. HTML allowed.
`id`	string	The id for the dialog.
`maskBlur`	boolean	Whether to blur the background when the dialog is open.
`maskClasses`	string	The classes for the mask. Space seperated string.
`maskTheme`	boolean	Background mask theme, `none`, `light` or `dark`.
`mode`	string	The mode for the dialog. `alert`, `confirm` or `dialog`.
`position`	string	The position for the dialog. `center`, `top` or `bottom`.
`title`	string	The title for the dialog.
`titleIcon`	string	The icon for the title.
`titleIconColor`	string	The color for the title icon.
`wrapperClasses`	string	The classes for the wrapper. Space seperated string.
`zIndex`	number	The z-index for the dialog.

Since: 1.0.6
Source: modules/Dialog/index.js, line 11

Returns:

string

Example

import { dialogTemplate } from '@gravityforms/components/html/admin/modules/Dialog';

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

dropdownTemplate(options) → {string}

Generates the markup for a dropdown in the admin.

Parameters:

Name Type Description

options

object

The options for the component template.

Properties

Name	Type	Description
`attributes`	string	The attributes to add to the wrapper element, space seperated.
`container`	string	The container to append the dropdown to.
`dropdownListAttributes`	string	The attributes to add to the dropdown list element.
`hasSearch`	boolean	Whether or not to show the search input.
`listData`	Array	The list data for the dropdown.
`searchAriaText`	string	The aria text for the search input.
`searchInputId`	string	The id for the search input.
`searchPlaceholder`	string	The placeholder for the search input.
`selector`	string	The selector for the dropdown.
`triggerAriaId`	string	The id for the trigger aria.
`triggerAriaText`	string	The aria text for the trigger.
`triggerClasses`	string	The classes for the trigger.
`triggerId`	string	The id for the trigger.
`triggerPlaceholder`	string	The placeholder for the trigger.
`triggerSelected`	string	The selected item for the trigger.
`triggerTitle`	string	The title for the trigger.
`wrapperClasses`	string	The classes for the wrapper, space seperated string.

Since: 1.1.16
Source: elements/Dropdown/index.js, line 38

Returns:

Type:: string

Example

import { dropdownTemplate } from '@gravityforms/components/html/admin/elements/Dropdown';

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

flyoutTemplate(options) → {string}

The template function that returns html for the flyout. Options below are passed from constructor and described there.

Parameters:

Name Type Description

options

object

The options for the flyout.

Properties

Name	Type	Description
`closeButtonClasses`	string	The classes for the close button.
`closeButtonTitle`	string	The title for the close button.
`content`	string	The content for the flyout.
`description`	string	The description for the flyout. Found under the title in the header.
`desktopWidth`	number	The flyout desktop width in percentage.
`direction`	string	Direction to fly in from, left or right.
`expandable`	boolean	Whether the flyout shows an extra trigger to allow expanding to a larger width.
`expandableTitle`	string	The title for the expandable trigger.
`id`	string	The id for the flyout.
`maxWidth`	number	The flyout max width in pixels.
`mobileBreakpoint`	number	The breakpoint for mobile in pixels.
`mobileWidth`	number	The flyout mobile width in percentage.
`position`	string	The position of the flyout, fixed or absolute positioning
`showDivider`	boolean	Whether to show the divider between the header and content.
`simplebar`	boolean	Whether to use simplebar for the content.
`title`	string	The title for the flyout.
`wrapperClasses`	string	The classes for the wrapper.
`zIndex`	number	The z-index for the flyout.

Since: 1.0.5
Source: modules/Flyout/index.js, line 16

Returns:

Type:: string

Example

import { flyoutTemplate } from '@gravityforms/components/html/admin/modules/Flyout';

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

headingTemplate(options) → {string}

Generates the markup for a Heading Element in the admin.

Parameters:

Name Type Description

options

object

The options for the heading component.

Properties

Name	Type	Description
`content`	string	Content for the heading.
`customClasses`	Array	An array of additional classes for the heading.
`id`	string	Id for the heading, auto generated if not passed.
`size`	string	Size string, check storybook for available ones.
`spacing`	string	Spacing for the component.
`tagName`	string	Tag for the heading, h1 if not passed.
`weight`	string	The font weight for the heading, regular, semibold or bold.

Since: 2.2.0
Source: elements/Heading/index.js, line 3

Returns:

Type:: string

Example

import { headingTemplate } from '@gravityforms/components/html/admin/elements/Heading';

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

helpTextTemplate(id, helpText) → {string}

The markup for form field helper text.

Parameters:

Name	Type	Description
`id`	string	Optional id. Auto generated if not passed.
`helpText`	string	Optional helper text.

Since: 1.1.18
Source: elements/Textarea/index.js, line 10

Returns:

Type:: string

helpTextTemplate(options) → {string}

The help text template function, can be used when not needing events or a help text instance.

Parameters:

Name Type Description

options

object

The options for the select component.

Properties

Name	Type	Description
`content`	string	Helper text.
`customAttributes`	object	Any custom attributes.
`customClasses`	Array	Any custom classes.
`id`	string	Id for the helper text.
`size`	string	The font size for the helper text.
`spacing`	string \| number \| Array	The spacing for the component, string or array.
`weight`	string	The font weight for the label.

Since: 2.2.0
Source: elements/HelpText/index.js, line 2

Returns:

The html for the help text component.

Type:: string

init() → {void}

Initialize the component.

Since: 1.0.0
Source: elements/Select/index.js, line 299

Returns:

Type:: void

init() → {void}

Initialize the heading.

Since: 2.2.0
Source: elements/Heading/index.js, line 146

Returns:

Type:: void

init() → {void}

Initialize the help text.

Since: 2.2.0
Source: elements/HelpText/index.js, line 123

Returns:

Type:: void

init() → {void}

Initialize the label.

Since: 2.2.0
Source: elements/Label/index.js, line 153

Returns:

Type:: void

init() → {void}

Initialize the text.

Since: 2.2.0
Source: elements/Text/index.js, line 143

Returns:

Type:: void

init()

Initialize and execute a snackbar.

Source: modules/SnackBar/index.js, line 191

inputTemplate(options) → {string}

Generates the markup for a input 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.
`id`	string	Id for the input, auto generated if not passed.
`inputPrefix`	string	The prefix for the input.
`inputSuffix`	string	The suffix for the input.
`label`	string	For radio or checkboxes, the label text.
`labelAttributes`	string	Any other arbitrary attributes to add to the label.
`labelClasses`	string	Space separated string of classes to add to the label.
`placeholder`	string	Input placeholder text.
`actionButton`
`actionButtonIcon`
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`theme`	string	Theme for the toggle, primary or cosmos.
`type`	string	Input type: `text`, `email`, `tel`, `url`, `checkbox` or `radio`.
`value`	string	The value for the input.

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

Returns:

Type:: string

Example

import { inputTemplate } from '@gravityforms/components/html/admin/elements/Input';

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

labelTemplate(id, label, labelCustomAttributes, labelCustomClasses, labelVisible) → {string}

The markup for form field label.

Parameters:

Name	Type	Description
`id`	string	Optional id. Auto generated if not passed.
`label`	string	Label for the textarea.
`labelCustomAttributes`	object	Any custom attributes for the label.
`labelCustomClasses`	Array	Any custom classes for the label.
`labelVisible`	boolean	If the label should be visible. Defaults to true.

Since: 1.1.18
Source: elements/Textarea/index.js, line 39

Returns:

Type:: string

labelTemplate(options) → {string}

Generates the markup for a Label Element in the admin.

Parameters:

Name Type Description

options

object

The options for the label component.

Properties

Name	Type	Description
`customAttributes`	object	Any custom attributes.
`customClasses`	Array	Any custom classes.
`htmlFor`	string	The for attribute for the label.
`label`	string	Label text.
`isVisible`	boolean	If label is visible (true) or hidden (false).
`size`	string	The font size for the label.
`spacing`	string \| number \| Array	The spacing for the component, string or array.
`weight`	string	The font weight for the label.

Since: 2.2.0
Source: elements/Label/index.js, line 3

Returns:

The html for the label component.

Type:: string

Example

import { labelTemplate } from '@gravityforms/components/html/admin/elements/Label';

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

linkTemplate(options) → {string}

Generates the markup for a link 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.
`href`	string	Href for the link.
`id`	string	Id for the link, auto generated if not passed.
`label`	string	Text label for the link.
`linkTarget`	string	Target for the link, eg _blank.
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`theme`	string	Theme for the toggle, primary or cosmos.

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

Returns:

Type:: string

Example

import { linkTemplate } from '@gravityforms/components/html/admin/elements/Link';

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

loaderTemplate(options) → {string}

Generates the markup for a loader in the admin.

Parameters:

Name Type Description

options

object

The options for the component template.

Properties

Name	Type	Description
`background`	string	The background color for the loader.
`customAttributes`	object	Any custom attributes.
`customClasses`	Array	An array of additional classes for the toggle.
`displayText`	boolean	Whether to display the loader text.
`foreground`	string	The foreground color for the loader.
`id`	string	Id for the loader, auto generated if not passed.
`mask`	string	The mask for the loader.
`maskTheme`	string	The mask theme for the loader.
`position`	string	The position for the loader.
`size`	string	The size for the loader.
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`text`	string	The text for the loader.
`textColor`	string	The text color for the loader.
`theme`	string	Theme for the toggle, primary or cosmos.
`type`	string	Type for the loader, spinner or bar.
`wrapperCustomAttributes`	object	Any custom attributes for the textarea wrapper.
`wrapperCustomClasses`	Array	Any custom classes for the textarea wrapper.
`wrapperTagName`	string	Tag to use for the textarea wrapper. Defaults to 'div',

Since: 1.1.16
Source: elements/Loader/index.js, line 11

Returns:

Type:: string

Example

import { loaderTemplate } from '@gravityforms/components/html/admin/elements/Loader';

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

render() → {void}

Renders the component into the dom.

Since: 1.0.0
Source: elements/Select/index.js, line 276

Returns:

Type:: void

render() → {string}

Renders the heading into the dom.

Since: 2.2.0
Source: elements/Heading/index.js, line 123

Returns:

Type:: string

render() → {void}

Renders the box into the dom.

Since: 2.2.0
Source: elements/HelpText/index.js, line 100

Returns:

Type:: void

render() → {void}

Renders the label into the dom.

Since: 2.2.0
Source: elements/Label/index.js, line 130

Returns:

Type:: void

render() → {string}

Renders the text into the dom.

Since: 2.2.0
Source: elements/Text/index.js, line 120

Returns:

Type:: string

render()

Renders the snackbar in the passed container option.

Source: modules/SnackBar/index.js, line 150

reveal()

Reveals the snackbar and if autohide true it starts the hide timer. If speak is true, announces the message as well to screenreaders.

Source: modules/SnackBar/index.js, line 119

selectTemplate(options) → {string}

A select component to use wherever a simple select is needed.

Parameters:

Name Type Description

options

object

The options for the select component.

Properties

Name	Type	Description
`customAttributes`	object	Custom attributes for the select.
`customClasses`	Array	An array of additional classes for the select.
`disabled`	boolean	If select is disabled.
`helpTextAttributes`	string	Custom attribute for the help text.
`helpTextPosition`	string	The position of the help text. Above or below.
`id`	string	Optional id. Auto generated if not passed.
`initialValue`	string	Initial value for the select.
`labelAttributes`	string	Any custom attributes for the label.
`name`	string	The name attribute for the select.
`options`	Array	An array of options, each option as an object in the following structure: { customOptionAttrs: {}, // Key-value pairs of custom attributes. customOptionClasses: [], // Array of strings of custom classes. label: '', // Label as a string. value: '', // Value as a string. }
`size`	string	The select size. Small (size-s), Regular (size-r), or extra large (size-xl).
`spacing`	string \| number \| Array	The spacing for the component, string or array.
`theme`	string	The theme of the select.
`customAttributes.optionGroup`
`customAttributes.groups`
`wrapperAttributes`	object	Any custom attributes for the wrapper element.
`wrapperClasses`	Array	Any custom classes for the wrapper element.
`wrapperTagName`	object	Tag to use for the textarea wrapper. Defaults to 'div'.
`ariaLabel`	string	The aria-label text for the select element.

Since: 2.2.0
Source: elements/Select/index.js, line 5

Returns:

The html for the select component.

Type:: string

Example

import { selectTemplate } from '@gravityforms/components/html/admin/elements/Select';

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

setOptions()

Merges the default options with the passed args.

Source: modules/SnackBar/index.js, line 168

snackBarHtml() → {string}

Uses our options to render the snackbar.

Source: modules/SnackBar/index.js, line 42

Returns:

The html for the snackbar.

Type:: string

stackedIconTemplate(options) → {string}

Generates the markup for a stackedIcon 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.
`id`	string	Id for the stackedIcon, auto generated if not passed.
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`tagName`	string	Tag to use for the icon wrapper. Defaults to 'span',
`theme`	string	Theme for the toggle, primary or cosmos.
`type`	string	The icon name string.

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

Returns:

Type:: string

Example

import { stackedIconTemplate } from '@gravityforms/components/html/admin/elements/StackedIcon';

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

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 );
}

textTemplate(options) → {string}

A text component to use wherever texts are needed.

Parameters:

Name Type Description

options

object

The options for the text component template.

Properties

Name	Type	Description
`content`	string	Content for the text.
`customClasses`	Array	An array of additional classes for the text.
`id`	string	Id for the text, auto generated if not passed.
`size`	string	Size string, check storybook for available ones.
`spacing`	string	Spacing for the component.
`tagName`	string	Tag for the text, h2 if not passed.
`weight`	string	The font weight for the text, regular, semibold or bold.

Since: 2.2.0
Source: elements/Text/index.js, line 3

Returns:

The html for the text component.

Type:: string

Example

import { textTemplate } from '@gravityforms/components/html/admin/elements/Text';

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

textareaTemplate(options) → {string}

The markup for a textarea.

Parameters:

Name Type Description

options

object

The options for the component template.

Properties

Name	Type	Description
`customAttributes`	object	Any custom attributes for the textarea.
`customClasses`	Array	Any custom classes for the textarea.
`helpText`	string	Optional helper text.
`id`	string	Optional id. Auto generated if not passed.
`label`	string	Label for the textarea.
`labelCustomAttributes`	object	Any custom attributes for the label.
`labelCustomClasses`	Array	Any custom classes for the label.
`labelVisible`	boolean	If the label should be visible. Defaults to true.
`disabled`	boolean	If the textarea should be disabled. Defaults to false.
`placeholder`	string	Optional placeholder text.
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`theme`	string	Theme for the toggle, primary or cosmos.
`value`	string	Optional initial value for the textarea.
`wrapperCustomAttributes`	object	Any custom attributes for the textarea wrapper.
`wrapperCustomClasses`	Array	Any custom classes for the textarea wrapper.
`wrapperTagName`	string	Tag to use for the textarea wrapper. Defaults to 'div',

Since: 1.1.18
Source: elements/Textarea/index.js, line 79

Requires:

module:labelTemplate
module:helpTextTemplate

Returns:

Type:: string

Example

import { textareaTemplate } from '@gravityforms/components/html/admin/elements/Textarea';

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

toggleTemplate(options) → {string}

Generates the markup for a toggle 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.
`disabled`	boolean	If the toggle is disabled.
`icons`	boolean	Do we use the checkmark and x icons for this instance.
`iconPrefix`	string	Prefix for the icon class.
`iconBefore`	string	Icon to display when toggle is off.
`iconAfter`	string	Icon to display when toggle is on.
`id`	string	Id for the toggle, auto generated if not passed.
`initialChecked`	boolean	Is it checked on render?
`label`	string	The label, required for accessibility.
`labelPosition`	string	Position for the label, defaults to right.
`labelVisible`	boolean	Is the label visible?
`name`	string	Name for the input.
`size`	string	Size for the toggle. Small (size-s), medium (size-m), or large (size-l).
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`theme`	string	Theme for the toggle, primary or cosmos.
`ariaDescribedby`	string	Class of the element that describes this input.

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

Returns:

Type:: string

Example

import { toggleTemplate } from '@gravityforms/components/html/admin/elements/Toggle';

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

Events

gform/alert/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Alert/index.js, line 286

gform/alert/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Alert/index.js, line 196

gform/button/activated

Fired when an interactive button is activated on document.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Button class instance.

Source: elements/Button/index.js, line 226

gform/button/deactivated

Fired when an interactive button is deactivated on document.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Button class instance.

Source: elements/Button/index.js, line 263

gform/button/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Button/index.js, line 399

gform/button/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Button/index.js, line 190

gform/dialog/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.0.6
Source: modules/Dialog/index.js, line 482

gform/dialog/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: modules/Dialog/index.js, line 218

Fired when the component has an item selected in the dropdown list.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.
`event`	object	The Component event object for the list item.

Since: 1.1.16
Source: elements/Dropdown/index.js, line 303

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Dropdown/index.js, line 679

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Dropdown/index.js, line 244

gform/flyout/close

Fired when the flyout closes.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 3.3.7
Source: modules/Flyout/index.js, line 298

gform/flyout/open

Fired when the flyout opens.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 3.3.7
Source: modules/Flyout/index.js, line 255

gform/flyout/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.0.5
Source: modules/Flyout/index.js, line 587

gform/flyout/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: modules/Flyout/index.js, line 218

gform/input/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Input/index.js, line 252

gform/input/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Input/index.js, line 196

gform/link/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Link/index.js, line 185

gform/link/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Link/index.js, line 129

gform/loader/post_hide

Fired when the component has completed hiding in the dom.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Loader/index.js, line 306

gform/loader/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Loader/index.js, line 397

gform/loader/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Loader/index.js, line 202

gform/stacked_icon/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/StackedIcon/index.js, line 174

gform/stacked_icon/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/StackedIcon/index.js, line 118

gform/status_indicator/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

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

gform/status_indicator/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

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

gform/textarea/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Textarea/index.js, line 315

gform/textarea/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Textarea/index.js, line 258

gform/toggle/post_render

Fired when the component has completed rendering and all class init functions have completed.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Toggle/index.js, line 230

gform/toggle/pre_init

Fired before the component has started any internal init functions. A great chance to augment the options.

Type:

object

Properties

Name	Type	Description
`instance`	object	The Component class instance.

Since: 1.1.16
Source: elements/Toggle/index.js, line 173

Methods

alertTemplate(options) → {string}

Properties

bindEvents()

buttonTemplate(options) → {string}

Properties

cleanUp()

close()

dialogTemplate(options)

Properties

dropdownTemplate(options) → {string}

Properties

flyoutTemplate(options) → {string}

Properties

headingTemplate(options) → {string}

Properties

helpTextTemplate(id, helpText) → {string}

helpTextTemplate(options) → {string}

Properties

init() → {void}

init() → {void}

init() → {void}

init() → {void}

init() → {void}

init()

inputTemplate(options) → {string}

Properties

labelTemplate(id, label, labelCustomAttributes, labelCustomClasses, labelVisible) → {string}

labelTemplate(options) → {string}

Properties

linkTemplate(options) → {string}

Properties

loaderTemplate(options) → {string}

Properties

render() → {void}

render() → {string}

render() → {void}

render() → {void}

render() → {string}

render()

reveal()

selectTemplate(options) → {string}

Properties

setOptions()

snackBarHtml() → {string}

stackedIconTemplate(options) → {string}

Properties

statusIndicatorTemplate(options) → {string}

Properties

textTemplate(options) → {string}

Properties

textareaTemplate(options) → {string}

Properties

toggleTemplate(options) → {string}

Properties

Events

gform/alert/post_render

gform/alert/pre_init

gform/button/activated

gform/button/deactivated

gform/button/post_render

gform/button/pre_init

gform/dialog/post_render

gform/dialog/pre_init

gform/dropdown/item_selected

gform/dropdown/post_render

gform/dropdown/pre_init

gform/flyout/close

gform/flyout/open

gform/flyout/post_render

gform/flyout/pre_init

gform/input/post_render

gform/input/pre_init

gform/link/post_render

gform/link/pre_init

gform/loader/post_hide

gform/loader/post_render

gform/loader/pre_init

gform/stacked_icon/post_render

gform/stacked_icon/pre_init