Stripe Apps の Switch コンポーネント

Checkbox と同様に、Switch を使用して boolean 値の指定または制御を行うことができます。

SDK バージョン

Switch コンポーネントをアプリに追加するには、以下のようにします。

import {Switch} from '@stripe/ui-extension-sdk/ui';

Switch (スイッチ) は一般に、すぐに保存する設定に使用されます。そのため、Switch が、別々に送信する必要がある大規模なフォームの構成部分になることは稀です。

Switch の単純な例を次に示します。

サンプルを読み込み中...

<Switch
  label="This is a Switch."
  onChange={(e) => {
    console.log(e.target.checked);
  }}
/>

Switch props

プロパティー	タイプ
`autoFocus`	オプション `boolean \| undefined` If `true`, React will focus the element on mount.
`checked`	オプション `boolean \| undefined` Controls whether the input is selected. When you pass this prop, you must also pass an `onChange` handler that updates the passed value.
`defaultChecked`	オプション `boolean \| undefined` Specifies the initial value that a user can change.
`description`	オプション `string \| undefined` コントロールのラベルの横にレンダリングされる説明テキスト。
`disabled`	オプション `boolean \| undefined` 要素を無効化するかどうかを設定します。選択できなくなります。
`error`	オプション `string \| undefined` コントロールの下に表示されるエラーテキスト。
`form`	オプション `string \| undefined` Specifies the `id` of the `<form>` this input belongs to. If omitted, it’s the closest parent form.
`hiddenElements`	オプション `("label" \| "description" \| "error")[] \| undefined` 指定した要素を視覚的に非表示にします。非表示の要素は引き続き存在しており、スクリーンリーダーに表示されます。
`invalid`	オプション `boolean \| undefined` 要素が無効な状態であるかどうかを設定します。これは、表示専用のプロパティであり、フォーム送信を妨げるものではありません。
`label`	オプション `React.ReactNode` コントロールを説明するテキスト。表示され、クリック可能になります。
`name`	オプション `string \| undefined` Specifies the name for this input that’s submitted with the form.
`onChange`	オプション `((event: React.ChangeEvent<HTMLInputElement>) => void) \| undefined` Required for controlled inputs. Fires immediately when the input’s value is changed by the user (for example, it fires on every keystroke). Behaves like the browser input event.
`readOnly`	オプション `boolean \| undefined` If `true`, the input is not editable by the user.
`required`	オプション `boolean \| undefined` If `true`, the value must be provided for the form to submit.
`tabIndex`	オプション `number \| undefined` Overrides the default tab key behavior. Avoid using values other than `-1` and `0`.
`value`	オプション `string \| undefined` Controls the input’s text. When you pass this prop, you must also pass an `onChange` handler that updates the passed value.

ステータス管理

Use the Switch component as an uncontrolled input:

サンプルを読み込み中...

<Switch
  onChange={(e) => {
    console.log(e.target.checked);
  }}
  defaultChecked
  label="This Switch is uncontrolled."
/>

無効化

Switch コンポーネントは無効化でき、これにより変更できなくなります。

サンプルを読み込み中...

<Switch label="This Switch is disabled." defaultChecked disabled />

注

Stripe Apps の Switch コンポーネント

Checkbox と同様に、Switch を使用して boolean 値の指定または制御を行うことができます。

Switch props

ステータス管理

無効化

参照情報