Skip to content

SColorField <s-color-field> ​

Một ô nhập văn bản để nhập giá trị màu, có thể kèm kênh alpha. SColorField là Vue 3 wrapper có type cho web component <s-color-field> của Shopify Polaris.

ts
import { SColorField } from 'polaris-vue-elements'

Best practices ​

  • Nêu rõ màu dùng cho việc gì. Dùng label như "Button background color" hay "Heading text color" thay vì một từ chung chung như "Color".
  • Hiển thị màu hiện tại khi chỉnh sửa. Đặt value là màu hiện có để người bán thấy họ đang thay đổi từ màu nào.
vue
<SColorField label="Button background color" value="#1a1a1a" />

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

Ví dụ ​

Value: #008060

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

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

<template>
  <SColorField label="Brand color" v-model="value" />
  <p>Value: {{ value }}</p>
</template>

v-model ​

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

template
<SColorField v-model="value" />

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

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

Props ​

PropKiểuMô tả
alphabooleanCho phép người dùng chọn giá trị alpha.
autocomplete"on" | "off"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.
defaultValuestringGiá trị mặc định của trường.
detailsanyVă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.
disabledbooleanVô hiệu hóa trường, không cho phép bất kỳ tương tác nào.
erroranyBá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.
idstringĐịnh danh duy nhất của phần tử.
labelanyNộ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).
namestringĐịnh danh cho trường, là duy nhất trong form chứa nó gần nhất.
placeholderstringGợi ý ngắn mô tả giá trị mong đợi của trường.
readOnlybooleanNgườ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.
requiredbooleanTrườ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.
valuestringGiá trị hiện tại của trường. Nếu bỏ qua, trường sẽ trống.

Events ​

EventKiểu
blurFocusEvent
changeEvent
focusFocusEvent
inputEvent

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

Slots ​

SlotMô tả
details
error

Phát hành theo giấy phép MIT. Logo Vue của Evan You, CC BY-NC-SA 4.0.