Compact Address
<sc-compact-address></sc-compact-address>
This component let users create compact address.
- Preview
- Code
<sc-compact-address></sc-compact-address>
Component Codex
Properties
| Property | Description | Type | Default |
|---|---|---|---|
| address | The address. | { name?: string; line_1?: string; line_2?: string; city?: string; state?: string; postal_code?: string; country?: string; constructor?: Function; toString?: () => string; toLocaleString?: () => string; valueOf?: () => Object; hasOwnProperty?: (v: PropertyKey) => boolean; isPrototypeOf?: (v: Object) => boolean; propertyIsEnumerable?: (v: PropertyKey) => boolean; } | { country: null, city: null, line_1: null, line_2: null, postal_code: null, state: null, } |
| label | Label for the address | string | __('Country or region', 'surecart') |
| loading | Is this loading | boolean | |
| names | { name?: string; line_1?: string; line_2?: string; city?: string; state?: string; postal_code?: string; country?: string; constructor?: Function; toString?: () => string; toLocaleString?: () => string; valueOf?: () => Object; hasOwnProperty?: (v: PropertyKey) => boolean; isPrototypeOf?: (v: Object) => boolean; propertyIsEnumerable?: (v: PropertyKey) => boolean; } | { country: 'shipping_country', city: 'shipping_city', line_1: 'shipping_line_1', line_2: 'shipping_line_2', postal_code: 'shipping_postal_code', state: 'shipping_state', } | |
| placeholders | Placeholders | { name?: string; line_1?: string; line_2?: string; city?: string; state?: string; postal_code?: string; country?: string; constructor?: Function; toString?: () => string; toLocaleString?: () => string; valueOf?: () => Object; hasOwnProperty?: (v: PropertyKey) => boolean; isPrototypeOf?: (v: Object) => boolean; propertyIsEnumerable?: (v: PropertyKey) => boolean; } | { country: '', postal_code: '', state: '', } |
| required | Is this required? | boolean |
Events
| Event | Description | Type |
|---|---|---|
scChangeAddress | Address change event. | CustomEvent<{ name?: string; line_1?: string; line_2?: string; city?: string; state?: string; postal_code?: string; country?: string; constructor?: Function; toString?: () => string; toLocaleString?: () => string; valueOf?: () => Object; hasOwnProperty?: (v: PropertyKey) => boolean; isPrototypeOf?: (v: Object) => boolean; propertyIsEnumerable?: (v: PropertyKey) => boolean; }> |
scInputAddress | Address input event. | CustomEvent<{ name?: string; line_1?: string; line_2?: string; city?: string; state?: string; postal_code?: string; country?: string; constructor?: Function; toString?: () => string; toLocaleString?: () => string; valueOf?: () => Object; hasOwnProperty?: (v: PropertyKey) => boolean; isPrototypeOf?: (v: Object) => boolean; propertyIsEnumerable?: (v: PropertyKey) => boolean; }> |
Methods
reportValidity() => Promise<boolean>
Shadow Parts
| Part | Description |
|---|---|
base | The elements base wrapper. |
block-ui | The block ui base component. |
block-ui__content | The block ui content (spinner). |
caret | The select box caret. |
control | |
empty | The select empty message. |
form-control | The form control wrapper. |
help-text | Help text that describes how to use the input. |
input | The html input element. |
input__base | The inputs base element. |
label | The input label. |
menu__base | The select menu base. |
panel | The select box panel. |
search__base | The select search base. |
search__form-control | The select search form control. |
search__input | The select search input. |
select__base | The select boxes base element. |
spinner__base | The select spinner base. |
trigger | The select box trigger. |