Slider field

info.magnolia.ui.field.SliderFieldDefinition renders a horizontal bar that allows you to set a numeric value within a defined range by dragging a handle with the mouse. The value appears as you move the handle.

Slider field definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.field.SliderFieldDefinition.

This field has been introduced since Magnolia 6.2. There is no corresponding implementation in the Magnolia 5 UI framework.

Example definition

slider:
  $type: sliderField
  label: Percentage
  defaultValue: 50
  stepSize: 5
  displayStepSize: 25
  valueFormat: PERCENTAGE

You can preview this example using the field-examples-module. See Field examples module for more information.

Field properties

Field-specific properties

Property Description

Property	Description
`title`	optional Title displayed above the slider. The value is i18n-able.
`min`	optional, default is `0` Minimum value of the slider range.
`max`	optional, default is `100` Maximum value of the slider range.
`stepSize`	optional, default is `1` Size of increments by which the slider handle moves. For this to work, the value must be greater than `0`.
`displayStepSize`	optional, default is `0` Size of increments by which values appear on the slider. `0` means no values are displayed. For this to work, the value must be greater than or equal to `0`.
`valueFormat`	optional, default is `NUMBER` Value format can be `NUMBER` or `PERCENTAGE`. When set to `PERCENTAGE`, the `%` character is appended to all displayed values.

title

optional

Title displayed above the slider. The value is i18n-able.

min

optional, default is 0

Minimum value of the slider range.

max

optional, default is 100

Maximum value of the slider range.

stepSize

optional, default is 1

Size of increments by which the slider handle moves. For this to work, the value must be greater than 0.

displayStepSize

optional, default is 0

Size of increments by which values appear on the slider. 0 means no values are displayed.

For this to work, the value must be greater than or equal to 0.

valueFormat

optional, default is NUMBER

Value format can be NUMBER or PERCENTAGE. When set to PERCENTAGE, the % character is appended to all displayed values.

Common simple field properties

Property Description

name

required

Name of the field definition item. Derived from the configured node name. Use alphanumeric characters without spaces.

class

required (unless $type is used)

Type of the field definition item. The value must be a fully qualified class name and a subtype of info.magnolia.ui.field.FieldDefinition. See Field types for possible values.

$type

You can use this as a shortcut for class if the definition class is annotated with info.magnolia.ui.field.FieldType. The proper value is defined by the annotation.

Example class annotation

@FieldType("textField")
public class TextFieldDefinition extends ConfiguredFieldDefinition<String> {
...
}

See Field types for possible values.

type

optional

Property type of the field.

A default type is typically hard-coded in each definition class. You only need to add this property if you want to override the default implementation.

In text fields, make sure that type has a value matching the type of data you entered (for example, java.lang.Long for long values) and that converterClass is set accordingly.

A scenario where you might require users to enter a particular numerical type is, for example, sorting the delivery REST JSON on your frontend.

Long example definition

text:
  $type: textField
  type: java.lang.Long
  converterClass: com.vaadin.data.converter.StringToLongConverter

Double example definition

text:
  $type: textField
  type: java.lang.Double
  converterClass: com.vaadin.data.converter.StringToDoubleConverter

You can’t configure this property through YAML but it can be used in your Java code.

converterClass

optional

Converts values between the presentation (UI) and model (stored data). The property must extend com.vaadin.data.Converter. Available classes:

info.magnolia.ui.editor.converter.JcrNodeToIdentifierConverter
info.magnolia.ui.editor.converter.JcrNodeToPathConverter
info.magnolia.ui.editor.converter.JcrNodeToWorkspaceAndIdConverter
info.magnolia.ui.editor.converter.JcrPathToIdentifierConverter

com.vaadin.data.converter.StringToBigDecimalConverter and com.vaadin.data.converter.StringToDoubleConverter always round the presentation value by default. For non-rounding converters, use the following classes instead:

info.magnolia.ui.field.converter.NonRoundingStringToBigDecimalConverter
info.magnolia.ui.field.converter.NonRoundingStringToDoubleConverter

You can’t configure this property through YAML but it can be used in your Java code.

conversionErrorMessage

optional, default is translated conversion.message.error key

Message shown when there is an error in the conversion process. The value can be literal or a key of a message bundle.

defaultValue

optional

Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.

This is only applied only when creating a new item, not for existing items.

For defaultValue to work, the populate property in info.magnolia.ui.dialog.actions.OpenDialogActionDefinition must be set to false.

description

optional

Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle.

factoryClass

optional

Defines the factory class that initializes and builds the Vaadin form field. The default factory class depends on the particular field.

The value must be a fully qualified class name and a subtype of info.magnolia.ui.field.FieldFactory.

You can’t configure this property through YAML but it can be used in your Java code.

fieldBinderClass

optional

Defines the binder class that applies configuration parameters from the field.

i18n

optional, default is false

Enables i18n authoring support, which allows editors to write foreign-language or regionally targeted content. A two-letter language identifier (en, de, fr, etc.) is displayed on controls where i18n is set to true.

label

optional

Field label displayed to editors. The value can be literal or a key of a message bundle.

If you do not provide the property, Magnolia will fall back to a generated i18n key.

If you do not want to have any label, set the property to an empty string such as label: "" in YAML.

readOnly

optional, default is false

Makes the field uneditable.

required

optional, default is false (not relevant for checkbox field)

Makes the field required. When true, an asterisk is displayed next to the field label.

When false, empty values are accepted as valid. For those empty values, any field validators are ignored.

requiredErrorMessage

optional, default is translated validation.message.required key

Error message shown when required is set to true and the user saves an empty field. The value can be literal or a key of a message bundle.

styleName

optional

Additional style information for an editor property definition item applied to the element when the form is rendered. The value can be a CSS class or a list of CSS classes separated by white spaces.

The style name will be rendered as an HTML class name, which can be used in a CSS definition. The class name is added to the field by calling the Vaadin method addStyleName.

The referenced class can be defined in:

validators

optional

List of field validator definition items. Any value must be a subtype of info.magnolia.ui.field.FieldValidatorDefinition.

See Field validators for more information.

Feedback

DX Core

Slider field

Example definition

Field properties

Field-specific properties

Common simple field properties

Location

Main doc sections