Copy page

@wocart/theme v4.1.0

---

@wocart/theme / index / CollectionFieldDefinition

Interface: CollectionFieldDefinition

collection: which of the store's collections to show here — Shopify's collection setting. The value is a collection handle (best-sellers); the theme lists its products with the storefront client's products.list({ collection }), in the merchant's order. An unknown handle lists nothing.

Extends

• FieldDefinitionBase

Properties

default?

optional default?: string

---

description?

optional description?: LocalizedText

Editor-facing help text.

Inherited from

FieldDefinitionBase.description

---

key

key: string

The exact prop name the component expects.

Inherited from

FieldDefinitionBase.key

---

kind

kind: "collection"

---

label

label: LocalizedText

Editor-facing name, the same in every language or translated.

Inherited from

FieldDefinitionBase.label

---

required?

optional required?: boolean

Inherited from

FieldDefinitionBase.required

---

visibleIf?

optional visibleIf?: FieldCondition

When an editor shows the field; absent: always. The renderer ignores it.

Inherited from

FieldDefinitionBase.visibleIf