UnitControl Edit

UnitControl allows the user to set a value as well as a unit (e.g. px).

Usage Usage

import { __experimentalUnitControl as UnitControl } from '@wordpress/components';
import { useState } from '@wordpress/element';

const Example = () => {
    const [ value, setValue ] = useState( '10px' );

    return <UnitControl onChange={ setValue } value={ value } />;
};

Top ↑

Props Props

disabledUnits disabledUnits

If true, the unit <select> is hidden.

  • Type: Boolean
  • Required: No
  • Default: false

Top ↑

isPressEnterToChange isPressEnterToChange

If true, the ENTER key press is required in order to trigger an onChange. If enabled, a change is also triggered when tabbing away (onBlur).

  • Type: Boolean
  • Required: No
  • Default: false

Top ↑

isUnitSelectTabbable isUnitSelectTabbable

Determines if the unit <select> is tabbable.

  • Type: Boolean
  • Required: No
  • Default: true

Top ↑

label label

If this property is added, a label will be generated using label property as the content.

  • Type: String
  • Required: No

Top ↑

labelPosition labelPosition

The position of the label (top, side, bottom, or edge).

  • Type: String
  • Required: No

Top ↑

onChange onChange

Callback when the value changes.

  • Type: Function
  • Required: No
  • Default: noop

Top ↑

onUnitChange onUnitChange

Callback when the unit changes.

  • Type: Function
  • Required: No
  • Default: noop

Top ↑

size size

Adjusts the size of the input.
Sizes include: default, small

  • Type: String
  • Required: No
  • Default: default

Top ↑

unit unit

Deprecated: Current unit value.
Instead, provide a unit with a value through the value prop.

Example:

<UnitControl value="50%" />
  • Type: String
  • Required: No

Top ↑

units units

Collection of available units.

  • Type: Array<Object>
  • Required: No

Example:

import { __experimentalUnitControl as UnitControl } from '@wordpress/block-editor/';

const Example = () => {
    const [ value, setValue ] = useState( '10px' );
    const units = [
        { value: 'px', label: 'px', default: 0 },
        { value: '%', label: '%', default: 10 },
        { value: 'em', label: 'em', default: 0 },
    ];

    return <UnitControl onChange={ setValue } value={ value } />;
};

A default value for (in the example above, 10 for %), if defined, is set as the new value when a unit changes. This is helpful in scenarios where changing a unit may cause drastic results, such as changing from px to vh.

Top ↑

value value

Current value. To set a unit, provide a unit with a value through the value prop.

Example:

<UnitControl value="50%" />
  • Type: Number|String
  • Required: No