STextArea `<s-text-area>`

メモや説明文など、長いコンテンツ向けの複数行テキスト入力。 STextArea は、Shopify Polaris の <s-text-area> web component 向けの型付き Vue 3 wrapper です。

import { STextArea } from 'polaris-vue-elements'

ベストプラクティス

想定される回答に合わせてサイズを決める。 表示される rows の数は、どれくらい書けばよいかを示します。小さなエリアは短い回答を、高さのあるエリアはより詳しい内容を求めていることを伝えます。
実際の必要性に基づいて文字数の制限を設定する。 minLength と maxLength はコンテンツに実際に必要な量に基づいて決め、その制限をマーチャントに前もって伝えます。
プレースホルダーは例として使う。 placeholder には、フィールドの用途を繰り返すのではなく、期待するコンテンツの種類、形式、トーンを示すテキストを書きます。
残りの文字数を表示する。 最大文字数を設けている場合は、残りの文字数をマーチャントが確認できるようにし、上限を超えずに内容を収められるようにします。

vue

<STextArea label="Product description" :rows="6" :maxLength="500" placeholder="Handwoven from organic cotton, this throw adds warmth to any room." />

詳しいガイダンスについては、<s-text-area> に関する Shopify のベストプラクティス（英語）を参照してください。

例

Value: (empty)

vue

<script setup>
import { ref } from 'vue'
import { STextArea } from 'polaris-vue-elements'

const value = ref('')
</script>

<template>
  <STextArea label="Bio" placeholder="Tell us about yourself" :rows="3" v-model="value" />
  <p>Value: {{ value }}</p>
</template>

v-model

<STextArea> の v-model は value プロパティにバインドされ、input DOM イベントを監視します。

template

<STextArea v-model="value" />

これは次と同等です：

template

<STextArea :value="value" @input="value = $event.target.value" />

Props

Prop	型	説明
`autocomplete`	`"language" \| "organization" \| "name" \| "additional-name" \| "address-level1" \| "address-level2" \| "address-level3" \| "address-level4" … (84 more)`	フィールドに入力される内容のヒントです。`on`（デフォルト）に設定すると、フィールドがオートフィルをサポートすべきであることを示しますが、想定される内容についてそれ以上の意味的な情報はありません。`off` に設定すると、このフィールドに機密情報、またはワンタイムコードのように保存されることのない内容が含まれることを示します。あるいは、オートフィル時にこのフィールドに入力してほしい具体的なデータを表す値を指定することもできます。
`defaultValue`	`string`	フィールドのデフォルト値です。
`details`	`any`	フィールドのコンテキストやガイダンスを提供する追加のテキストです。このテキストはフィールドとそのラベルとともに表示され、ユーザーに詳しい情報や手順を伝えます。スクリーンリーダーのユーザーにも公開されます。
`disabled`	`boolean`	フィールドを無効にし、あらゆる操作を受け付けないようにします。
`error`	`any`	ユーザーにエラーを示します。すぐに解決する必要がある問題を伝えるため、フィールドに特定のスタイルが適用されます。
`id`	`string`	要素の一意な識別子です。
`label`	`any`	フィールドのラベルとして使用するコンテンツです。
`labelAccessibilityVisibility`	`"visible" \| "exclusive"`	コンポーネントのラベルの表示状態を変更します。 - `visible`: ラベルはすべてのユーザーに表示されます。 - `exclusive`: ラベルは視覚的に非表示になりますが、アクセシビリティツリーには残ります。
`maxLength`	`number`	入力できる最大文字数を指定します。
`minLength`	`number`	入力できる最小文字数を指定します。
`name`	`string`	最も近い親のフォーム内で一意となる、フィールドの識別子です。
`placeholder`	`string`	フィールドに期待される値を説明する短いヒントです。
`readOnly`	`boolean`	ユーザーはフィールドを編集できません。フォーカスは可能で、スクリーンリーダーによって読み上げられます。
`required`	`boolean`	フィールドに値が必要かどうか。この要件はフィールドにセマンティックな意味を加えますが、エラーが自動的に表示されるわけではありません。このフィールドが空のときにエラーを表示したい場合は、`error` プロパティを使用してください。
`rows`	`number`	表示されるテキストの行数です。
`value`	`string`	フィールドの現在の値です。省略した場合、フィールドは空になります。

上記の一部の型の列は読みやすさのために省略されています。完全な union はライブラリが生成する TypeScript の型（src/lib/generated/types.ts）で確認できます。

Events

Event	型
`blur`	`FocusEvent`
`change`	`Event`
`focus`	`FocusEvent`
`input`	`Event`

これらのイベントは <STextArea> 上で @blur 形式のリスナーで受け取れます。

Slots

Slot	説明
`details`
`error`

STextArea <s-text-area> ​

ベストプラクティス ​

例 ​

v-model ​

Props ​

Events ​

Slots ​