field().labelInfo()

Get / set label information for the field.
Please note - this property requires the Editor extension for DataTables.

The full Editor reference documentation is available to registered users of Editor - the information shown below is a summary only. If you already have an Editor license please sign-in, alternatively an Editor license can be purchased on this site, or sign up for the free trial.

Description

A short description explaining a field can often be beneficial to let users know what a field is used for, and thus what data is expected from them. This method can be used to get / set a field's label information (which is shown directly under the label itself - fields.label / field().label()).

Label information can be set when it is initially added to the form using the fields.labelInfo option. This API method extends that ability by providing a method to get and set the field information message any point after a field has been added to the form.

Editor provides three different elements for information display in each field, which can be used independently of each other, or in conjunction as required by your user interface design:

• fields.message / field().message(): Dynamic information about a field that is typically updated based on user input. This is shown below the field's user input area.
• fields.fieldInfo / field().fieldInfo(): Very similar to the message option, but typically used for static information about an input - e.g. explaining what format is expected, or what the input value is used for.
• fields.labelInfo / field().labelInfo(): Information message shown below the field's label element.

Comments (0)