STextArea <s-text-area>
메모나 설명처럼 긴 내용을 위한 여러 줄 텍스트 입력 필드입니다. STextArea은(는) Shopify Polaris <s-text-area> web component를 위한 타입이 지정된 Vue 3 wrapper입니다.
ts
import { STextArea } from 'polaris-vue-elements'모범 사례
- 예상되는 답변에 맞게 크기를 정하세요. 보이는
rows수는 얼마나 써야 하는지를 알려 줍니다. 짧은 영역은 간단한 답을, 높은 영역은 더 자세한 내용을 요청합니다. - 실제 필요에 맞는 길이 제한을 설정하세요. 콘텐츠에 실제로 필요한 만큼을 기준으로
minLength와maxLength를 정하고, 그 제한을 판매자에게 미리 알려 줍니다. - placeholder를 예시로 사용하세요. 필드의 용도를 반복하지 말고, 기대하는 콘텐츠의 종류, 형식, 어조를 보여 주는
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 property에 바인딩되고 input DOM event를 수신합니다.
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 형식의 리스너로 이 events를 수신하세요.
Slots
| Slot | 설명 |
|---|---|
details | |
error |