使用法

固定背景設定を変更するためのユーザーインターフェースをレンダリングします。

  1. import { useState } from 'react';
  2. import { ToggleControl } from '@wordpress/components';
  3. const MyToggleControl = () => {
  4. const [ hasFixedBackground, setHasFixedBackground ] = useState( false );
  5. return (
  6. <ToggleControl
  7. __nextHasNoMarginBottom
  8. label="Fixed Background"
  9. help={
  10. hasFixedBackground
  11. ? 'Has fixed background.'
  12. : 'No fixed background.'
  13. }
  14. checked={ hasFixedBackground }
  15. onChange={ (newValue) => {
  16. setHasFixedBackground( newValue );
  17. } }
  18. />
  19. );
  20. };

プロパティ

コンポーネントは以下のプロパティを受け入れます:

ラベル

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

  • タイプ: String
  • 必須: いいえ

ヘルプ

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

コントロールされたコンポーネントの場合、helpプロパティは、ブール値checkedパラメータに応じて動的にヘルプテキストを返す関数でも構いません。

  • タイプ: String|Element|Function
  • 必須: いいえ

チェック済み

チェック済みがtrueの場合、トグルはチェックされます。チェック済みがfalseの場合、トグルはチェックされません。

値が渡されない場合、トグルは初期値がチェックされていない制御されていないコンポーネントになります。

  • タイプ: Boolean
  • 必須: いいえ

無効

無効がtrueの場合、トグルは無効になり、適切なスタイルが適用されます。

  • タイプ: Boolean
  • 必須: いいえ

変更時

チェック状態(ブール値)を入力として受け取る関数です。

  • タイプ: function
  • 必須: いいえ

クラス名

  1. - タイプ: `````String
  • 必須: いいえ

__nextHasNoMarginBottom

将来のバージョンでデフォルトになる新しいマージンなしスタイルを選択し始めます。

  • タイプ: Boolean
  • 必須: いいえ
  • デフォルト: false