使用法

  1. import { useState } from 'react';
  2. import { __experimentalUnitControl as UnitControl } from '@wordpress/components';
  3. const Example = () => {
  4. const [ value, setValue ] = useState( '10px' );
  5. return <UnitControl onChange={ setValue } value={ value } />;
  6. };

プロパティ

disableUnits: boolean

trueの場合、単位<select>は非表示になります。

  • 必須: いいえ
  • デフォルト: false

isPressEnterToChange: boolean

もしtrueの場合、ENTERキーの押下がonChangeをトリガーするために必要です。有効にすると、タブキーで移動したときにも変更がトリガーされます(onBlur)。

  • 必須: いいえ
  • デフォルト: false

isResetValueOnUnitChange: boolean

もしtrueの場合、選択された単位がdefaultの値を提供する場合、この値は単位を変更するときに設定されます。

  • 必須: いいえ
  • デフォルト: false

isUnitSelectTabbable: boolean

単位<select>がタブ可能かどうかを決定します。

  • 必須: いいえ
  • デフォルト: true

label: string

このプロパティが追加されると、labelプロパティをコンテンツとして使用してラベルが生成されます。

  • 必須: いいえ

labelPosition: string

ラベルの位置(topsidebottom、またはedge)。

  • 必須: いいえ

onBlur: FocusEventHandler< HTMLInputElement | HTMLSelectElement >

数量または単位入力がblurイベントを発火したときに呼び出されるコールバック。

  • 必須: いいえ

onFocus: FocusEventHandler< HTMLInputElement | HTMLSelectElement >

数量または単位入力がfocusイベントを発火したときに呼び出されるコールバック。

  • 必須: いいえ

onChange: UnitControlOnChangeCallback

  1. - 必須: いいえ
  2. <a name="onunitchange-unitcontrolonchangecallback"></a>
  3. ### onUnitChange: UnitControlOnChangeCallback
  4. `````unit`````が変更されたときのコールバック。
  5. - 必須: いいえ
  6. <a name="size-string"></a>
  7. ### size: string
  8. 入力のサイズを調整します。
  9. サイズには、`````default``````````small`````が含まれます。
  10. - 必須: いいえ
  11. - デフォルト: `````default

unit: string

非推奨: 現在の単位値。

代わりに、valueプロパティを通じて値を持つ単位を提供してください。

例:

  1. <UnitControl value="50%" />
  • 必須: いいえ

units: WPUnitControlUnit[]

利用可能な単位のコレクション。

  • 必須: いいえ

例:

  1. import { useState } from 'react';
  2. import { __experimentalUnitControl as UnitControl } from '@wordpress/components';
  3. const Example = () => {
  4. const [ value, setValue ] = useState( '10px' );
  5. const units = [
  6. { value: 'px', label: 'px', default: 0 },
  7. { value: '%', label: '%', default: 10 },
  8. { value: 'em', label: 'em', default: 0 },
  9. ];
  10. return (
  11. <UnitControl onChange={ setValue } value={ value } units={ units } />
  12. );
  13. };
  1. <a name="value-number-string"></a>
  2. ### value: number | string
  3. 現在の値。文字列として渡された場合、この値から現在の単位が推測されます。
  4. 例えば、`````value`````が`````50%`````の場合、現在の単位は`````%`````に設定されます。
  5. 例:
  6. ``````bash
  7. <UnitControl value="50%" />
  8. `
  • 必須: いいえ

__next40pxDefaultSize: boolean

将来のバージョンでデフォルトサイズになる大きなデフォルト高さを選択し始めます。

  • 必須: いいえ
  • デフォルト: false