Class: Label

new Label(options) → {Class}

A label component with optional header area to contain a group of html elements.

Parameters:

Name Type Description

options

object

Component options.

Properties

Name	Type	Description
`customAttributes`	object	Custom attributes for the component.
`customClasses`	string \| Array \| object	Custom classes for the component.
`htmlFor`	string	The for attribute for the label.
`isVisible`	boolean	If label is visible (true) or hidden (false).
`rendered`	boolean	Is this label already rendered in the dom, eg by php?
`renderOnInit`	boolean	Render the label on init of the class?
`label`	string	Label text.
`size`	string	The font size for the label.
`spacing`	string \| number \| Array \| object	The spacing for the component, as a string, number, array, or object.
`target`	string	The target to render to. Any valid css selector string.
`targetPosition`	string	The insert position for the target.
`weight`	string	The font weight for the label.

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

Returns:

The Label instance.

Type:: Class

Example

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

function Example() {
     const labelInstance = new Label( {
         label: 'Label text',
         htmlFor: 'input-id',
         target: '#example-target',
     } );
}