STextArea <s-text-area>

Một ô nhập văn bản nhiều dòng cho nội dung dài hơn như ghi chú hoặc mô tả. STextArea là Vue 3 wrapper có type cho web component <s-text-area> của Shopify Polaris.

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

Best practices

• Định cỡ theo câu trả lời mong đợi. Số rows hiển thị cho biết nên viết bao nhiêu: một vùng nhập thấp gợi ý câu trả lời ngắn, còn vùng cao hơn yêu cầu nhiều chi tiết hơn.
• Đặt giới hạn độ dài phản ánh nhu cầu thực. Chọn minLength và maxLength dựa trên những gì nội dung thực sự cần, và cho người bán biết các giới hạn đó ngay từ đầu.
• Dùng placeholder làm ví dụ. Viết placeholder thể hiện loại nội dung, định dạng và giọng điệu bạn mong đợi, thay vì lặp lại mục đích của trường.
• Hiển thị còn bao nhiêu chỗ. Khi bạn áp đặt độ dài tối đa, hãy cho người bán thấy còn bao nhiêu ký tự để họ viết vừa mà không vượt quá.

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

Xem best practices của Shopify cho <s-text-area> (tiếng Anh) để có hướng dẫn đầy đủ.

Ví dụ

Value: (empty)

<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

v-model trên <STextArea> gắn với property value và lắng nghe DOM event input.

<STextArea v-model="value" />

tương đương với:

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

Props

Prop	Kiểu	Mô tả
autocomplete	"language" | "organization" | "name" | "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" … (84 more)	Gợi ý về nội dung dự kiến của trường. Khi đặt thành on (mặc định), thuộc tính này cho biết trường nên hỗ trợ tự động điền, nhưng bạn không có thêm thông tin ngữ nghĩa nào về nội dung dự kiến. Khi đặt thành off, bạn cho biết trường này chứa thông tin nhạy cảm, hoặc nội dung không bao giờ được lưu, như mã dùng một lần. Ngoài ra, bạn có thể cung cấp giá trị mô tả loại dữ liệu cụ thể mà bạn muốn được nhập vào trường này khi tự động điền.
defaultValue	string	Giá trị mặc định của trường.
details	any	Văn bản bổ sung cung cấp ngữ cảnh hoặc hướng dẫn cho trường. Văn bản này được hiển thị cùng với trường và nhãn của nó để cung cấp thêm thông tin hoặc chỉ dẫn cho người dùng. Văn bản này cũng được cung cấp cho người dùng trình đọc màn hình.
disabled	boolean	Vô hiệu hóa trường, không cho phép bất kỳ tương tác nào.
error	any	Báo lỗi cho người dùng. Trường sẽ được áp dụng kiểu hiển thị riêng để thông báo các vấn đề cần được giải quyết ngay.
id	string	Định danh duy nhất của phần tử.
label	any	Nội dung dùng làm nhãn của trường.
labelAccessibilityVisibility	"visible" | "exclusive"	Thay đổi khả năng hiển thị của nhãn của component. - visible: nhãn hiển thị với mọi người dùng. - exclusive: nhãn bị ẩn về mặt thị giác nhưng vẫn nằm trong cây trợ năng (accessibility tree).
maxLength	number	Chỉ định số ký tự tối đa được phép.
minLength	number	Chỉ định số ký tự tối thiểu được phép.
name	string	Định danh cho trường, là duy nhất trong form chứa nó gần nhất.
placeholder	string	Gợi ý ngắn mô tả giá trị mong đợi của trường.
readOnly	boolean	Người dùng không thể chỉnh sửa trường. Trường vẫn có thể nhận focus và sẽ được trình đọc màn hình thông báo.
required	boolean	Trường có bắt buộc phải có giá trị hay không. Yêu cầu này bổ sung giá trị ngữ nghĩa cho trường, nhưng sẽ không tự động hiển thị lỗi. Nếu muốn hiển thị lỗi khi trường này trống, bạn có thể dùng thuộc tính error.
rows	number	Số dòng văn bản hiển thị.
value	string	Giá trị hiện tại của trường. Nếu bỏ qua, trường sẽ trống.

Một số cột kiểu ở trên đã được rút gọn cho dễ đọc; union đầy đủ có trong type TypeScript được generate của thư viện (src/lib/generated/types.ts).

Events

Event	Kiểu
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

Lắng nghe các event này bằng listener dạng @blur trên <STextArea>.

Slots

Slot	Mô tả
details
error