class Range in Drupal 10
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Render/Element/Range.php \Drupal\Core\Render\Element\Range
- 9 core/lib/Drupal/Core/Render/Element/Range.php \Drupal\Core\Render\Element\Range
Provides a slider for input of a number within a specific range.
Provides an HTML5 input element with type of "range".
Properties:
- #min: Minimum value (defaults to 0).
- #max: Maximum value (defaults to 100).
Refer to \Drupal\Core\Render\Element\Number for additional properties.
Usage example:
$form['quantity'] = array(
'#type' => 'range',
'#title' => $this
->t('Quantity'),
);
Plugin annotation
@FormElement("range");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Range
See also
\Drupal\Core\Render\Element\Number
6 string references to 'Range'
- ContextDefinitionIsSatisfiedTest::providerTestIsSatisfiedBy in core/
tests/ Drupal/ Tests/ Core/ Plugin/ Context/ ContextDefinitionIsSatisfiedTest.php - Provides test data for ::testIsSatisfiedBy().
- field_test_entity_bundle_field_info_alter in core/
modules/ field/ tests/ modules/ field_test/ field_test.module - Implements hook_entity_bundle_field_info_alter().
- form_test.routing.yml in core/
modules/ system/ tests/ modules/ form_test/ form_test.routing.yml - core/modules/system/tests/modules/form_test/form_test.routing.yml
- IntegerItem::getConstraints in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ IntegerItem.php - Gets a list of validation constraints.
- NumericItemBase::getConstraints in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ NumericItemBase.php - Gets a list of validation constraints.
2 #type uses of Range
- FormTestRangeForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestRangeForm.php - Form constructor.
- FormTestRangeInvalidForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestRangeInvalidForm.php - Form constructor.
File
- core/
lib/ Drupal/ Core/ Render/ Element/ Range.php, line 30
Namespace
Drupal\Core\Render\ElementView source
class Range extends Number {
/**
* {@inheritdoc}
*/
public function getInfo() {
$info = parent::getInfo();
$class = static::class;
return [
'#min' => 0,
'#max' => 100,
'#pre_render' => [
[
$class,
'preRenderRange',
],
],
'#theme' => 'input__range',
] + $info;
}
/**
* Prepares a #type 'range' render element for input.html.twig.
*
* @param array $element
* An associative array containing the properties of the element.
* Properties used: #title, #value, #description, #min, #max, #attributes,
* #step.
*
* @return array
* The $element with prepared variables ready for input.html.twig.
*/
public static function preRenderRange($element) {
$element['#attributes']['type'] = 'range';
Element::setAttributes($element, [
'id',
'name',
'value',
'step',
'min',
'max',
]);
static::setAttributes($element, [
'form-range',
]);
return $element;
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
if ($input === '') {
$offset = ($element['#max'] - $element['#min']) / 2;
// Round to the step.
if (strtolower($element['#step']) != 'any') {
$steps = round($offset / $element['#step']);
$offset = $element['#step'] * $steps;
}
return $element['#min'] + $offset;
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
MessengerTrait:: |
protected | property | The messenger. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
Number:: |
public static | function | Prepares a #type 'number' render element for input.html.twig. | |
Number:: |
public static | function | Form element validation handler for #type 'number'. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 53 |
Range:: |
public | function |
Returns the element properties for this element. Overrides Number:: |
|
Range:: |
public static | function | Prepares a #type 'range' render element for input.html.twig. | |
Range:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElement:: |
|
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |