SUrlField <s-url-field>
웹 주소를 입력하는 텍스트 입력 필드입니다. SUrlField은(는) Shopify Polaris <s-url-field> web component를 위한 타입이 지정된 Vue 3 wrapper입니다.
ts
import { SUrlField } from 'polaris-vue-elements'모범 사례
- URL은 직접 검증하세요. 브라우저의 기본 URL 검증은 최소한이며 브라우저마다 다르므로, 구조, 허용되는 프로토콜, 사용 사례에서 받아들이는 형식에 대한 검사를 직접 추가합니다.
- 기대하는 형식을 보여 주세요. 프로토콜을 포함해야 하는지, 어떤 프로토콜이 허용되는지, 어떤 종류의 URL을 원하는지 판매자에게 알려 줍니다.
placeholder에 완전한 예시 URL을 넣으면 이를 분명히 할 수 있습니다. - 프로토콜이 빠진 경우의 처리를 정하세요. 판매자는
https://를 빠뜨리는 경우가 많습니다. 자동으로 붙여 줄지, 프로토콜 없는 URL을 허용할지, 무엇이 빠졌는지 설명하는error를 보여 줄지 결정합니다. - URL이 사용되는 곳에 맞게 길이 제한을 정하세요. 브라우저와 서버가 처리하는 최대 길이는 서로 다르므로, 임의의 숫자가 아니라 URL의 목적지에 따라
maxLength를 설정하고, 중요한 경우 그 제한을 알려 줍니다. - URL의 용도를 설명하세요. 상품 이미지 URL, 소셜 프로필 링크, 외부 참조는 각각 요구하는 것이 다르므로,
label과details로 목적을 분명히 합니다.
vue
<SUrlField label="Product image URL" placeholder="https://example.com/images/product.jpg" details="Link directly to a JPG or PNG file." />전체 가이드는 <s-url-field>에 대한 Shopify 모범 사례(영어)를 참고하세요.
예시
Value: (empty)
vue
<script setup>
import { ref } from 'vue'
import { SUrlField } from 'polaris-vue-elements'
const value = ref('')
</script>
<template>
<SUrlField label="Website" placeholder="https://example.com" v-model="value" />
<p>Value: {{ value }}</p>
</template>v-model
<SUrlField>의 v-model은 value property에 바인딩되고 input DOM event를 수신합니다.
template
<SUrlField v-model="value" />다음과 동일합니다:
template
<SUrlField :value="value" @input="value = $event.target.value" />Props
| Prop | 타입 | 설명 |
|---|---|---|
autocomplete | "photo" | "url" | "impp" | "home impp" | "mobile impp" | "fax impp" | "pager impp" | "on" … (15 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 속성을 사용하면 됩니다. |
value | string | 필드의 현재 값입니다. 생략하면 필드가 비어 있습니다. |
위의 일부 타입 열은 읽기 쉽도록 축약되었습니다. 전체 union은 라이브러리에서 생성된 TypeScript 타입(
src/lib/generated/types.ts)에 있습니다.
Events
| Event | 타입 |
|---|---|
blur | FocusEvent |
change | Event |
focus | FocusEvent |
input | Event |
<SUrlField>에서 @blur 형식의 리스너로 이 events를 수신하세요.
Slots
| Slot | 설명 |
|---|---|
details | |
error |