TextField

TextField を使用して、テキスト入力フィールドを作成します。

SDK バージョン

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

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

<TextField
  label="Business name"
  placeholder="Acme Inc…"
  onChange={(e) => {
    console.log(e.target.value);
  }}
/>

TextField のプロパティー

プロパティー	タイプ
`autoComplete`	オプション `string \| undefined` Specifies one of the possible autocomplete behaviors.
`autoFocus`	オプション `boolean \| undefined` If `true`, React will focus the element on mount.
`css`	オプション `Object` Related types: CSS.
`defaultValue`	オプション `string \| 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` コントロールを説明するテキスト。表示され、クリック可能になります。
`maxLength`	オプション `number \| undefined` Specifies the maximum length of text.
`minLength`	オプション `number \| undefined` Specifies the minimum length of text.
`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.
`onKeyDown`	オプション `((event: React.KeyboardEvent<HTMLInputElement>) => void) \| undefined` Fires when a key is pressed.
`onKeyUp`	オプション `((event: React.KeyboardEvent<HTMLInputElement>) => void) \| undefined` Fires when a key is released.
`placeholder`	オプション `string \| undefined` Displayed in a dimmed color when the input value is empty.
`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.
`size`	オプション `("small" \| "medium" \| "large") \| undefined` コンポーネントのサイズ。
`spellCheck`	オプション `boolean \| "true" \| "false" \| undefined` If explicitly set to `true` or `false`, enables or disables spellchecking.
`tabIndex`	オプション `number \| undefined` Overrides the default Tab button behavior. Avoid using values other than `-1` and `0`.
`type`	オプション `("number" \| "text" \| "search" \| "tel" \| "url" \| "email" \| "password") \| undefined` 入力のテキストに類似したタイプから選択します。
`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.
`onKeyPress`	オプション非推奨 `((event: React.KeyboardEvent<HTMLInputElement>) => void) \| undefined`

CSS

プロパティータイプ

プロパティー	タイプ
`width`	オプション `(number \| "auto" \| "fill" \| "min" \| "max" \| "fit" \| "1/2" \| "1/3" \| "2/3" \| "1/4" \| "2/4" \| "3/4" \| "1/5" \| "2/5" \| "3/5" \| "4/5" \| "1/6" \| "2/6" \| "3/6" \| "4/6" \| "5/6" \| "1/12" \| "2/12" \| "3/12" \| "4/12" \| "5/12" \| "6/12" \| "7/12" \| "8/12" \| "9/12" \| "10/12" \| "11/12") \| undefined` The width of the component. See Sizing for details.

width

オプション

(number | "auto" | "fill" | "min" | "max" | "fit" | "1/2" | "1/3" | "2/3" | "1/4" | "2/4" | "3/4" | "1/5" | "2/5" | "3/5" | "4/5" | "1/6" | "2/6" | "3/6" | "4/6" | "5/6" | "1/12" | "2/12" | "3/12" | "4/12" | "5/12" | "6/12" | "7/12" | "8/12" | "9/12" | "10/12" | "11/12") | undefined

The width of the component. See Sizing for details.

無効

TextField エレメントに invalid を設定すると、コンポーネントをレンダリングし、指定された値が受け入れられないことを視覚的に示すために赤い輪郭線を表示できます。このプロパティを省略すると、デフォルトで false が設定されます。

<TextField label="Current year" defaultValue="1892" invalid />

タイプ

TextField の type プロパティーを設定して、予期されるテキスト値のタイプに応じて異なる方法でレンダリングすることができます。これは、<input /> のタイプ属性と似ていますが、テキストが許可されるタイプに制限されています。このプロパティーを省略すると、デフォルトで text になります。

<TextField label="Text" type="text" />
<TextField label="Password" type="password" />
<TextField label="Search" type="search" />
<TextField label="Number" type="number" />

サイズ

size を変更すると、デフォルト値より少し大きい、または少し小さいサイズを選択できます。一般に、同一のフォーム内で異なるサイズを組み合わせることはお勧めしません。デフォルト値は medium です。

<TextField label="Small" size="small" />
<TextField label="Medium" size="medium" />
<TextField label="Large" size="large" />

無効と読み取り専用

フィールドに disabled (無効) のマークを付けることができます。これにより、そのフィールドが使われなくなり、デザインが変わります。無効にすると、フォームの送信時にそのフォームエレメントのデータが送信されなくなります。

フィールドを readOnly (読み取り専用) にすることもできます。読み取り専用の場合、エレメント内のデータは送信されますが、ユーザーはそのデータを変更できません。

<TextField label="Disabled" defaultValue="Field is disabled" disabled />
<TextField label="Readonly" defaultValue="Field is readonly" readOnly />

ステータス管理

Use the TextField component as an uncontrolled input:

<TextField
  onChange={(e) => {
    console.log(e);
  }}
  label="First name"
/>

幅

Set the width of a TextField component using the available values with the css prop:

<TextField label="Search" type="search" css={{width: 'fill'}} />

注

TextField

TextField を使用して、テキスト入力フィールドを作成します。

TextField のプロパティー

CSS

無効

タイプ

サイズ

無効と読み取り専用

ステータス管理

幅

参照情報