@wix/agent-skills 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +111 -0
- package/package.json +29 -0
- package/skills/wix-app/SKILL.md +344 -0
- package/skills/wix-app/references/APP_IDENTIFIERS.md +35 -0
- package/skills/wix-app/references/APP_MARKET_REVIEW.md +311 -0
- package/skills/wix-app/references/APP_VALIDATION.md +171 -0
- package/skills/wix-app/references/BACKEND_API.md +233 -0
- package/skills/wix-app/references/BACKEND_EVENT.md +116 -0
- package/skills/wix-app/references/CODE_QUALITY.md +33 -0
- package/skills/wix-app/references/CUSTOM_ELEMENT_WIDGET.md +587 -0
- package/skills/wix-app/references/DASHBOARD_MENU_PLUGIN.md +157 -0
- package/skills/wix-app/references/DASHBOARD_MODAL.md +283 -0
- package/skills/wix-app/references/DASHBOARD_PAGE.md +403 -0
- package/skills/wix-app/references/DASHBOARD_PLUGIN.md +205 -0
- package/skills/wix-app/references/DATA_COLLECTION.md +451 -0
- package/skills/wix-app/references/DOCUMENTATION.md +42 -0
- package/skills/wix-app/references/EDITOR_REACT_COMPONENT.md +65 -0
- package/skills/wix-app/references/EMBEDDED_SCRIPT.md +468 -0
- package/skills/wix-app/references/EXTENSION_REGISTRATION.md +96 -0
- package/skills/wix-app/references/SERVICE_PLUGIN.md +235 -0
- package/skills/wix-app/references/SITE_PLUGIN.md +436 -0
- package/skills/wix-app/references/STORES_VERSIONING.md +334 -0
- package/skills/wix-app/references/backend-event/COMMON-EVENTS.md +84 -0
- package/skills/wix-app/references/custom-element-widget/SETTINGS_PANEL.md +345 -0
- package/skills/wix-app/references/dashboard-menu-plugin/blog-slots.md +71 -0
- package/skills/wix-app/references/dashboard-menu-plugin/bookings-slots.md +58 -0
- package/skills/wix-app/references/dashboard-menu-plugin/crm-slots.md +8 -0
- package/skills/wix-app/references/dashboard-menu-plugin/ecommerce-slots.md +17 -0
- package/skills/wix-app/references/dashboard-menu-plugin/events-slots.md +29 -0
- package/skills/wix-app/references/dashboard-menu-plugin/restaurants-slots.md +27 -0
- package/skills/wix-app/references/dashboard-menu-plugin/stores-slots.md +35 -0
- package/skills/wix-app/references/dashboard-page/API_SPEC.md +138 -0
- package/skills/wix-app/references/dashboard-page/DASHBOARD_API.md +573 -0
- package/skills/wix-app/references/dashboard-page/DYNAMIC_PARAMETERS.md +269 -0
- package/skills/wix-app/references/dashboard-page/ECOM_NAVIGATION.md +164 -0
- package/skills/wix-app/references/dashboard-plugin/SLOTS.md +294 -0
- package/skills/wix-app/references/data-collection/WIX_DATA.md +270 -0
- package/skills/wix-app/references/data-collection/extension-template.ts +107 -0
- package/skills/wix-app/references/editor-react-component/ACCESSIBILITY.md +138 -0
- package/skills/wix-app/references/editor-react-component/COMPONENT-API.md +454 -0
- package/skills/wix-app/references/editor-react-component/COMPONENT-CONFIGURATION.md +165 -0
- package/skills/wix-app/references/editor-react-component/CSS-GUIDELINES.md +576 -0
- package/skills/wix-app/references/editor-react-component/DIRECTIONALITY.md +170 -0
- package/skills/wix-app/references/editor-react-component/EDIT-FLOW.md +6 -0
- package/skills/wix-app/references/editor-react-component/PARTS.md +25 -0
- package/skills/wix-app/references/editor-react-component/PROPS-VS-CSS.md +203 -0
- package/skills/wix-app/references/editor-react-component/REACT-GUIDELINES.md +167 -0
- package/skills/wix-app/references/editor-react-component/REACT-PATTERNS.md +137 -0
- package/skills/wix-app/references/service-plugin/ADDITIONAL-FEES.md +112 -0
- package/skills/wix-app/references/service-plugin/BOOKINGS-STAFF-SORTING.md +118 -0
- package/skills/wix-app/references/service-plugin/DISCOUNT-TRIGGERS.md +87 -0
- package/skills/wix-app/references/service-plugin/GIFT-CARDS.md +86 -0
- package/skills/wix-app/references/service-plugin/PAYMENT-SETTINGS.md +135 -0
- package/skills/wix-app/references/service-plugin/SHIPPING-RATES.md +79 -0
- package/skills/wix-app/references/service-plugin/VALIDATIONS.md +68 -0
- package/skills/wix-app/references/site-plugin/EXAMPLES.md +311 -0
- package/skills/wix-app/references/site-plugin/SLOTS.md +263 -0
- package/skills/wix-design-system/SKILL.md +129 -0
- package/skills/wix-design-system/references/file-structure.md +56 -0
- package/skills/wix-design-system/scripts/wds.cjs +531 -0
- package/skills/wix-headless/SKILL.md +418 -0
- package/skills/wix-headless/references/DISCOVERY.md +332 -0
- package/skills/wix-headless/references/ORCHESTRATION.md +269 -0
- package/skills/wix-headless/references/SETUP.md +154 -0
- package/skills/wix-headless/references/blog/BLOG_CONTENT.md +152 -0
- package/skills/wix-headless/references/blog/BLOG_PAGES.md +299 -0
- package/skills/wix-headless/references/blog/BLOG_SETUP.md +218 -0
- package/skills/wix-headless/references/blog/INSTRUCTIONS.md +32 -0
- package/skills/wix-headless/references/cms/CMS_FOUNDATIONS.md +373 -0
- package/skills/wix-headless/references/cms/FAQ_KNOWLEDGE_BASE.md +229 -0
- package/skills/wix-headless/references/cms/INSTRUCTIONS.md +40 -0
- package/skills/wix-headless/references/cms/PORTFOLIO.md +454 -0
- package/skills/wix-headless/references/cms/RESOURCE_LIBRARY.md +356 -0
- package/skills/wix-headless/references/cms/TEAM_DIRECTORY.md +299 -0
- package/skills/wix-headless/references/commands/install-app.md +42 -0
- package/skills/wix-headless/references/commands/known-apps.json +5 -0
- package/skills/wix-headless/references/commands/mcp-bootstrap.md +28 -0
- package/skills/wix-headless/references/designer/INSTRUCTIONS.md +828 -0
- package/skills/wix-headless/references/ecom/CART_PAGES.md +120 -0
- package/skills/wix-headless/references/ecom/CART_WIRING.md +103 -0
- package/skills/wix-headless/references/ecom/COMPONENTS_CSS.md +132 -0
- package/skills/wix-headless/references/ecom/INSTRUCTIONS.md +59 -0
- package/skills/wix-headless/references/forms/CONTACT_FORM.md +477 -0
- package/skills/wix-headless/references/forms/INSTRUCTIONS.md +43 -0
- package/skills/wix-headless/references/gift-cards/COMPONENTS.md +119 -0
- package/skills/wix-headless/references/gift-cards/INSTRUCTIONS.md +51 -0
- package/skills/wix-headless/references/gift-cards/PAGES.md +129 -0
- package/skills/wix-headless/references/images/INSTRUCTIONS.md +359 -0
- package/skills/wix-headless/references/shared/BUILD_NOISE.md +8 -0
- package/skills/wix-headless/references/shared/IMAGE_GENERATION.md +185 -0
- package/skills/wix-headless/references/shared/IMPLEMENTER.md +155 -0
- package/skills/wix-headless/references/shared/MCP_PREFIX.md +105 -0
- package/skills/wix-headless/references/shared/PRODUCTION_SHARP_EDGES.md +97 -0
- package/skills/wix-headless/references/shared/RETURN_CONTRACT.md +423 -0
- package/skills/wix-headless/references/shared/STYLING.md +117 -0
- package/skills/wix-headless/references/stores/BACK_IN_STOCK.md +178 -0
- package/skills/wix-headless/references/stores/CATEGORY_PAGES.md +86 -0
- package/skills/wix-headless/references/stores/COMPONENTS_CSS.md +129 -0
- package/skills/wix-headless/references/stores/HOME_AND_NAV.md +227 -0
- package/skills/wix-headless/references/stores/INSTRUCTIONS.md +96 -0
- package/skills/wix-headless/references/stores/PRODUCT_CATALOG_DATA.md +249 -0
- package/skills/wix-headless/references/stores/PRODUCT_PAGES.md +213 -0
- package/skills/wix-headless/references/stores/SHARED_WIRING.md +164 -0
- package/skills/wix-headless/references/verticals/_schema.json +160 -0
- package/skills/wix-headless/references/verticals/_schema.md +185 -0
- package/skills/wix-headless/references/verticals/blog.md +125 -0
- package/skills/wix-headless/references/verticals/cms.md +121 -0
- package/skills/wix-headless/references/verticals/ecom.md +96 -0
- package/skills/wix-headless/references/verticals/forms.md +106 -0
- package/skills/wix-headless/references/verticals/gift-cards.md +121 -0
- package/skills/wix-headless/references/verticals/stores.md +167 -0
- package/skills/wix-headless/scripts/check-manifest.mjs +198 -0
- package/skills/wix-headless/scripts/copy-utility-templates.mjs +153 -0
- package/skills/wix-headless/scripts/emit-design-tokens.mjs +77 -0
- package/skills/wix-headless/scripts/finalize-run-json.mjs +141 -0
- package/skills/wix-headless/scripts/init-site-json.mjs +63 -0
- package/skills/wix-headless/scripts/patch-decorative-slots.mjs +124 -0
- package/skills/wix-headless/scripts/plan-entity-image-waves.mjs +190 -0
- package/skills/wix-headless/scripts/preview.sh +45 -0
- package/skills/wix-headless/scripts/release.sh +73 -0
- package/skills/wix-headless/scripts/scaffold.sh +53 -0
- package/skills/wix-headless/scripts/seed-utilities.sh +55 -0
- package/skills/wix-headless/shared-utilities/analytics.ts +40 -0
- package/skills/wix-headless/shared-utilities/ricos.ts +179 -0
- package/skills/wix-headless/shared-utilities/wix-image.ts +72 -0
- package/skills/wix-headless/templates/ecom/CartBadge.tsx +84 -0
- package/skills/wix-headless/templates/ecom/CartView.tsx +543 -0
- package/skills/wix-headless/templates/ecom/cart.astro +13 -0
- package/skills/wix-headless/templates/ecom/components-ecom.css +215 -0
- package/skills/wix-headless/templates/ecom/discounts.ts +71 -0
- package/skills/wix-headless/templates/ecom/thank-you.astro +24 -0
- package/skills/wix-headless/templates/gift-cards/GiftCardPurchase.tsx +172 -0
- package/skills/wix-headless/templates/gift-cards/_home-teaser-snippet.astro +42 -0
- package/skills/wix-headless/templates/gift-cards/_nav-snippet.astro +11 -0
- package/skills/wix-headless/templates/gift-cards/components-gift-cards.css +219 -0
- package/skills/wix-headless/templates/gift-cards/gift-cards.astro +51 -0
- package/skills/wix-headless/templates/gift-cards/gift-cards.ts +75 -0
- package/skills/wix-headless/templates/stores/AddToCartButton.tsx +77 -0
- package/skills/wix-headless/templates/stores/BackInStockForm.tsx +176 -0
- package/skills/wix-headless/templates/stores/CategoryRail.astro +69 -0
- package/skills/wix-headless/templates/stores/ProductCard.astro +79 -0
- package/skills/wix-headless/templates/stores/ProductPurchase.tsx +397 -0
- package/skills/wix-headless/templates/stores/SeoTags.astro +21 -0
- package/skills/wix-headless/templates/stores/back-in-stock.ts +67 -0
- package/skills/wix-headless/templates/stores/categories.ts +155 -0
- package/skills/wix-headless/templates/stores/category/[slug].astro +130 -0
- package/skills/wix-headless/templates/stores/components-stores.css +295 -0
- package/skills/wix-headless/templates/stores/products/[slug].astro +128 -0
- package/skills/wix-headless/templates/stores/products/index.astro +101 -0
- package/skills/wix-manage/SKILL.md +280 -0
- package/skills/wix-manage/references/app-installation/install-wix-apps.md +155 -0
- package/skills/wix-manage/references/app-installation/list-installed-apps.md +124 -0
- package/skills/wix-manage/references/blog/how-to-create-blog-posts.md +226 -0
- package/skills/wix-manage/references/bookings/booking-service-policy-setup.md +95 -0
- package/skills/wix-manage/references/bookings/booking-system-integration-gaps.md +416 -0
- package/skills/wix-manage/references/bookings/bookings-staff-setup.md +255 -0
- package/skills/wix-manage/references/bookings/create-and-update-booking-services.md +462 -0
- package/skills/wix-manage/references/bookings/end-to-end-booking-flow.md +278 -0
- package/skills/wix-manage/references/bookings/external-calendar-integration.md +258 -0
- package/skills/wix-manage/references/bookings/multi-resource-service-creation.md +231 -0
- package/skills/wix-manage/references/calendar/configure-default-business-hours.md +226 -0
- package/skills/wix-manage/references/cms/cms-data-items-crud.md +422 -0
- package/skills/wix-manage/references/cms/cms-data-operations-extended.md +263 -0
- package/skills/wix-manage/references/cms/cms-ecommerce-catalog-integration.md +136 -0
- package/skills/wix-manage/references/cms/cms-references-and-relationships.md +160 -0
- package/skills/wix-manage/references/cms/cms-schema-management.md +143 -0
- package/skills/wix-manage/references/contacts/bulk-delete-contacts.md +73 -0
- package/skills/wix-manage/references/contacts/bulk-label-and-unlabel-contacts.md +67 -0
- package/skills/wix-manage/references/domains/domain-search-and-purchase.md +434 -0
- package/skills/wix-manage/references/ecommerce/api-recommendation-tracking.md +420 -0
- package/skills/wix-manage/references/ecommerce/flow-add-free-shipping.md +267 -0
- package/skills/wix-manage/references/ecommerce/flow-bundle-and-save.md +290 -0
- package/skills/wix-manage/references/ecommerce/flow-fix-coverage-gaps.md +300 -0
- package/skills/wix-manage/references/ecommerce/flow-optimize-shipping-rates.md +364 -0
- package/skills/wix-manage/references/ecommerce/flow-seasonal-promotion.md +315 -0
- package/skills/wix-manage/references/ecommerce/flow-stock-mover.md +308 -0
- package/skills/wix-manage/references/ecommerce/flow-upsell-boost.md +271 -0
- package/skills/wix-manage/references/ecommerce/goal-clear-inventory.md +118 -0
- package/skills/wix-manage/references/ecommerce/goal-drive-cross-sells.md +122 -0
- package/skills/wix-manage/references/ecommerce/goal-increase-aov.md +132 -0
- package/skills/wix-manage/references/ecommerce/goal-reduce-cart-abandonment.md +148 -0
- package/skills/wix-manage/references/ecommerce/goal-seasonal-revenue.md +146 -0
- package/skills/wix-manage/references/ecommerce/guardrail-discount-conflicts.md +118 -0
- package/skills/wix-manage/references/ecommerce/guardrail-margin-protection.md +88 -0
- package/skills/wix-manage/references/ecommerce/guardrail-rate-pricing-sanity.md +108 -0
- package/skills/wix-manage/references/ecommerce/guardrail-shipping-health.md +124 -0
- package/skills/wix-manage/references/ecommerce/recipe-apply-shipping-recommendations.md +299 -0
- package/skills/wix-manage/references/ecommerce/recommend-ecommerce-strategy.md +582 -0
- package/skills/wix-manage/references/ecommerce/setup-coupons.md +338 -0
- package/skills/wix-manage/references/ecommerce/setup-discount-rules.md +444 -0
- package/skills/wix-manage/references/ecommerce/setup-shipping-rates.md +86 -0
- package/skills/wix-manage/references/ecommerce/setup-shipping-regions.md +56 -0
- package/skills/wix-manage/references/ecommerce/setup-store-pickup-location.md +209 -0
- package/skills/wix-manage/references/ecommerce/skill-graph.md +139 -0
- package/skills/wix-manage/references/ecommerce/troubleshoot-checkout-delivery-dropoff.md +124 -0
- package/skills/wix-manage/references/ecommerce/troubleshoot-discount-not-applying.md +95 -0
- package/skills/wix-manage/references/events/list-events.md +203 -0
- package/skills/wix-manage/references/forms/create-form.md +260 -0
- package/skills/wix-manage/references/get-paid/create-payment-links.md +212 -0
- package/skills/wix-manage/references/get-paid/how-to-setup-wix-payments.md +57 -0
- package/skills/wix-manage/references/get-paid/payment-links-for-bookings.md +101 -0
- package/skills/wix-manage/references/media/upload-media-to-wix.md +216 -0
- package/skills/wix-manage/references/pricing-plans/create-and-update-pricing-plans.md +77 -0
- package/skills/wix-manage/references/pricing-plans/pricing-plans-bookings-integration.md +166 -0
- package/skills/wix-manage/references/restaurants/wix-restaurants-setup.md +336 -0
- package/skills/wix-manage/references/rich-content/ricos-converter-service.md +295 -0
- package/skills/wix-manage/references/site-properties/change-payment-currency-site-properties.md +59 -0
- package/skills/wix-manage/references/sites/create-site-from-template.md +183 -0
- package/skills/wix-manage/references/sites/query-sites.md +125 -0
- package/skills/wix-manage/references/stores/add-store-pages-to-site.md +57 -0
- package/skills/wix-manage/references/stores/bulk-create-products-with-options.md +1041 -0
- package/skills/wix-manage/references/stores/create-product-catalog-v1.md +125 -0
- package/skills/wix-manage/references/stores/create-product-from-image.md +824 -0
- package/skills/wix-manage/references/stores/create-product-with-options-catalog-v3.md +566 -0
- package/skills/wix-manage/references/stores/find-products-query-and-search-catalog-v3.md +194 -0
- package/skills/wix-manage/references/stores/query-products-catalog-v1.md +80 -0
- package/skills/wix-manage/references/stores/setup-online-store-catalog-v3.md +99 -0
- package/skills/wix-manage/references/stores/update-product-pre-order.md +213 -0
- package/skills/wix-manage/references/stores/update-product-with-options.md +318 -0
|
@@ -0,0 +1,263 @@
|
|
|
1
|
+
# Site Plugin Slots Reference
|
|
2
|
+
|
|
3
|
+
This reference provides detailed information about all available slots for site plugins across Wix business solutions.
|
|
4
|
+
|
|
5
|
+
## Supported Pages and Slots
|
|
6
|
+
|
|
7
|
+
| Wix App | Supported Pages/Widgets |
|
|
8
|
+
| -------------- | ------------------------------------------------------------ |
|
|
9
|
+
| Wix Stores | Product Page (new and old versions), Category Page, Shop Page, Gallery Widget |
|
|
10
|
+
| Wix eCommerce | Checkout Page, Side Cart |
|
|
11
|
+
| Wix Bookings | Service Page |
|
|
12
|
+
| Wix Events | Event Details Page |
|
|
13
|
+
| Wix Blog | Post Page |
|
|
14
|
+
|
|
15
|
+
## Common Wix App IDs
|
|
16
|
+
|
|
17
|
+
| Wix App | App Definition ID |
|
|
18
|
+
| ---------------------- | -------------------------------------- |
|
|
19
|
+
| Wix Stores (Old) | `1380b703-ce81-ff05-f115-39571d94dfcd` |
|
|
20
|
+
| Wix Stores (New) | `a0c68605-c2e7-4c8d-9ea1-767f9770e087` |
|
|
21
|
+
| Wix Bookings | `13d21c63-b5ec-5912-8397-c3a5ddb27a97` |
|
|
22
|
+
| Wix Events | `140603ad-af8d-84a5-2c80-a0f60cb47351` |
|
|
23
|
+
| Wix Blog | `14bcded7-0066-7c35-14d7-466cb3f09103` |
|
|
24
|
+
| Wix Restaurants | `13e8d036-5516-6104-b456-c8466db39542` |
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Wix Stores Slots
|
|
29
|
+
|
|
30
|
+
### Product Page (New Version)
|
|
31
|
+
|
|
32
|
+
| Property | Value |
|
|
33
|
+
| ----------------- | ---------------------------------------- |
|
|
34
|
+
| `appDefinitionId` | `a0c68605-c2e7-4c8d-9ea1-767f9770e087` |
|
|
35
|
+
| `widgetId` | `6a25b678-53ec-4b37-a190-65fcd1ca1a63` |
|
|
36
|
+
|
|
37
|
+
**Available Slot IDs:**
|
|
38
|
+
- `product-page-media-1`
|
|
39
|
+
- `product-page-details-2`
|
|
40
|
+
|
|
41
|
+
**Note:** If using the `product-page-media-1` slot, it may overlap with the thumbnail images on the left side in desktop view. Consider offering settings in your app to control the left padding. ([Wix docs reference](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-plugins/supported-wix-app-pages/wix-stores/wix-stores-product-page))
|
|
42
|
+
|
|
43
|
+
**Plugin API Properties:**
|
|
44
|
+
- `productId` (string) - The ID of the product on the product page
|
|
45
|
+
- `selectedVariantId` (string) - The ID of the selected product variant. Only available after the site visitor picks all required product choices. Until all required choices are selected, this is `undefined`
|
|
46
|
+
- `selectedChoices` (object) - An object containing all choices the site visitor picks. Each key is an option name and each value is the selected option (e.g., `{ color: "green", size: "large" }`)
|
|
47
|
+
- `quantity` (number) - The number of product items the site visitor wants to buy
|
|
48
|
+
- `customText` (string[]) - An array of text values entered by the site visitor in custom text fields (e.g., personalization). Each entry corresponds to a different custom text field on the product page
|
|
49
|
+
|
|
50
|
+
### Product Page (Old Version)
|
|
51
|
+
|
|
52
|
+
| Property | Value |
|
|
53
|
+
| ----------------- | ---------------------------------------- |
|
|
54
|
+
| `appDefinitionId` | `1380b703-ce81-ff05-f115-39571d94dfcd` |
|
|
55
|
+
| `widgetId` | `13a94f09-2766-3c40-4a32-8edb5acdd8bc` |
|
|
56
|
+
|
|
57
|
+
**Available Slot IDs:**
|
|
58
|
+
- `product-page-details-2`
|
|
59
|
+
- Additional slots vary by layout (Classic, Simple, Sleek, Spotlight, Stunning)
|
|
60
|
+
|
|
61
|
+
**Note:** Check which Wix Stores version is installed before building
|
|
62
|
+
plugins, as slots differ between versions. Your app should include
|
|
63
|
+
placements for both versions for maximum compatibility.
|
|
64
|
+
|
|
65
|
+
**Plugin API Properties:** Same as New Version above.
|
|
66
|
+
|
|
67
|
+
### Category Page
|
|
68
|
+
|
|
69
|
+
| Property | Value |
|
|
70
|
+
| ----------------- | ---------------------------------------- |
|
|
71
|
+
| `appDefinitionId` | `1380b703-ce81-ff05-f115-39571d94dfcd` |
|
|
72
|
+
| `widgetId` | `bda15dc1-816d-4ff3-8dcb-1172d5343cce` |
|
|
73
|
+
|
|
74
|
+
**Plugin API Properties:**
|
|
75
|
+
- `categoryId` (string) - The ID of the category
|
|
76
|
+
|
|
77
|
+
### Shop Page
|
|
78
|
+
|
|
79
|
+
| Property | Value |
|
|
80
|
+
| ----------------- | ---------------------------------------- |
|
|
81
|
+
| `appDefinitionId` | `1380b703-ce81-ff05-f115-39571d94dfcd` |
|
|
82
|
+
| `widgetId` | `1380bba0-253e-a800-a235-88821cf3f8a4` |
|
|
83
|
+
|
|
84
|
+
**Plugin API Properties:**
|
|
85
|
+
- `categoryId` (string) - The category ID
|
|
86
|
+
|
|
87
|
+
### Gallery Widget
|
|
88
|
+
|
|
89
|
+
| Property | Value |
|
|
90
|
+
| ----------------- | ---------------------------------------- |
|
|
91
|
+
| `appDefinitionId` | `1380b703-ce81-ff05-f115-39571d94dfcd` |
|
|
92
|
+
| `widgetId` | `13afb094-84f9-739f-44fd-78d036adb028` |
|
|
93
|
+
|
|
94
|
+
**Plugin API Properties:**
|
|
95
|
+
- `categoryId` (string) - The category ID
|
|
96
|
+
|
|
97
|
+
**Note:** When selecting slots, use the same slot across Shop page, Gallery widget, and Category page to ensure compatibility across different Wix site setups.
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Wix eCommerce Slots
|
|
102
|
+
|
|
103
|
+
### Checkout Page
|
|
104
|
+
|
|
105
|
+
| Property | Value |
|
|
106
|
+
| ----------------- | ---------------------------------------- |
|
|
107
|
+
| `appDefinitionId` | `1380b703-ce81-ff05-f115-39571d94dfcd` |
|
|
108
|
+
| `widgetId` | `14fd5970-8072-c276-1246-058b79e70c1a` |
|
|
109
|
+
|
|
110
|
+
**Available Slot IDs:**
|
|
111
|
+
- `checkout:header`
|
|
112
|
+
- `checkout:top`
|
|
113
|
+
- `checkout:steps:before`
|
|
114
|
+
- `checkout:delivery-step:options:after`
|
|
115
|
+
- `checkout:policies:after-1`
|
|
116
|
+
- `checkout:summary:before`
|
|
117
|
+
- `checkout:summary:lineItems:after`
|
|
118
|
+
- `checkout:summary:lineItems:after2`
|
|
119
|
+
- `checkout:summary:totalsBreakdown:before`
|
|
120
|
+
- `checkout:summary:after`
|
|
121
|
+
|
|
122
|
+
**Note:** Some checkout plugins may not support automatic addition upon installation. Create a dashboard page to manage your site plugin.
|
|
123
|
+
|
|
124
|
+
**Checkout Plugin API Properties:**
|
|
125
|
+
- `checkoutId` (string) - ID of the current checkout process
|
|
126
|
+
- `stepId` (string) - Current step: `contact-details`, `delivery-method`, `payment-and-billing`, or `place-order`
|
|
127
|
+
- `checkoutUpdatedDate` (string) - When checkout was last updated
|
|
128
|
+
|
|
129
|
+
**Checkout Plugin API Functions:**
|
|
130
|
+
- `onRefreshCheckout(callback: () => void)` - An event handler that accepts a callback function invoked whenever the checkout needs to be refreshed
|
|
131
|
+
|
|
132
|
+
**Note:** The `checkout:delivery-step:options:after` slot uses a **different API** — see Delivery Step Options Slot API below.
|
|
133
|
+
|
|
134
|
+
#### Delivery Step Options Slot API
|
|
135
|
+
|
|
136
|
+
The `checkout:delivery-step:options:after` slot has its own API that is different from the other checkout slots.
|
|
137
|
+
|
|
138
|
+
**Properties:**
|
|
139
|
+
- `checkoutId` (string) - ID of the current checkout process
|
|
140
|
+
- `checkoutUpdatedDate` (string) - When checkout was last updated
|
|
141
|
+
- `selectedDeliveryOptionCarrierId` (string) - The ID of the carrier for the selected delivery option
|
|
142
|
+
- `selectedDeliveryOptionId` (string) - The ID of the selected delivery option
|
|
143
|
+
- `deliveryStepState` (string) - The current state of the delivery step. Possible values: `open` or `summary`
|
|
144
|
+
|
|
145
|
+
**Functions:**
|
|
146
|
+
- `onRefreshCheckout(callback: () => Promise)` - Event handler invoked whenever the checkout needs to be refreshed
|
|
147
|
+
- `disableContinueButton(callback: (isDisabled: boolean) => void)` - Event handler to control the checkout's continue button. Call with `true` to disable or `false` to enable
|
|
148
|
+
|
|
149
|
+
### Side Cart
|
|
150
|
+
|
|
151
|
+
| Property | Value |
|
|
152
|
+
| ----------------- | ---------------------------------------- |
|
|
153
|
+
| `appDefinitionId` | `1380b703-ce81-ff05-f115-39571d94dfcd` |
|
|
154
|
+
| `widgetId` | `49dbb2d9-d9e5-4605-a147-e926605bf164` |
|
|
155
|
+
|
|
156
|
+
**Available Slot IDs:**
|
|
157
|
+
- `side-cart:header:after-1`
|
|
158
|
+
- `side-cart:lineItems:after-1`
|
|
159
|
+
- `side-cart:customer-input:after-1`
|
|
160
|
+
- `side-cart:footer:actions:before-1`
|
|
161
|
+
- `side-cart:footer:actions:after-1`
|
|
162
|
+
|
|
163
|
+
**Note:** Some side cart plugins may not support automatic addition upon installation. Create a dashboard page to manage your site plugin.
|
|
164
|
+
|
|
165
|
+
**Design Guidelines:**
|
|
166
|
+
|
|
167
|
+
The Side Cart uses a `4px` baseline grid. Don't add extra spacing around your plugin — the slot handles spacing automatically.
|
|
168
|
+
|
|
169
|
+
| Slot | Recommended Height | Max Height |
|
|
170
|
+
| ------------------------------------- | ------------------ | ---------- |
|
|
171
|
+
| `side-cart:header:after-1` | `30px` | `70px` |
|
|
172
|
+
| `side-cart:lineItems:after-1` | `50px` | `150px` |
|
|
173
|
+
| `side-cart:customer-input:after-1` | `24px` | `150px` |
|
|
174
|
+
| `side-cart:footer:actions:before-1` | `50px` | `70px` |
|
|
175
|
+
| `side-cart:footer:actions:after-1` | `50px` | `70px` |
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## Wix Blog Slots
|
|
180
|
+
|
|
181
|
+
### Post Page
|
|
182
|
+
|
|
183
|
+
| Property | Value |
|
|
184
|
+
| ----------------- | ---------------------------------------- |
|
|
185
|
+
| `appDefinitionId` | `14bcded7-0066-7c35-14d7-466cb3f09103` |
|
|
186
|
+
| `widgetId` | `211b5287-14e2-4690-bb71-525908938c81` |
|
|
187
|
+
|
|
188
|
+
**Available Slot IDs:**
|
|
189
|
+
- `above-header`
|
|
190
|
+
- `above-content-1`
|
|
191
|
+
- `above-content-2`
|
|
192
|
+
- `below-content-1`
|
|
193
|
+
- `below-content-2`
|
|
194
|
+
- `page-bottom-1`
|
|
195
|
+
- `page-bottom-2`
|
|
196
|
+
- `page-bottom-3`
|
|
197
|
+
|
|
198
|
+
**Plugin API Properties:**
|
|
199
|
+
- `postId` (string) - The ID of the current post
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## Wix Bookings Slots
|
|
204
|
+
|
|
205
|
+
### Service Page
|
|
206
|
+
|
|
207
|
+
| Property | Value |
|
|
208
|
+
| ----------------- | ---------------------------------------- |
|
|
209
|
+
| `appDefinitionId` | `13d21c63-b5ec-5912-8397-c3a5ddb27a97` |
|
|
210
|
+
| `widgetId` | `a91a0543-d4bd-4e6b-b315-9410aa27bcde` |
|
|
211
|
+
| `slotId` | `slot1` |
|
|
212
|
+
|
|
213
|
+
The Service Page can host a single plugin that users are free to reposition within the page by reordering the Service Page sections.
|
|
214
|
+
|
|
215
|
+
**Plugin API Properties:**
|
|
216
|
+
- `bookingsServiceId` (string) - The ID of the Wix Bookings service currently applied on the plugin's host
|
|
217
|
+
|
|
218
|
+
---
|
|
219
|
+
|
|
220
|
+
## Wix Events Slots
|
|
221
|
+
|
|
222
|
+
### Event Details Page
|
|
223
|
+
|
|
224
|
+
| Property | Value |
|
|
225
|
+
| ----------------- | ---------------------------------------- |
|
|
226
|
+
| `appDefinitionId` | `140603ad-af8d-84a5-2c80-a0f60cb47351` |
|
|
227
|
+
| `widgetId` | `14d2abc2-5350-6322-487d-8c16ff833c8a` |
|
|
228
|
+
|
|
229
|
+
**Available Slot IDs:**
|
|
230
|
+
- `header`
|
|
231
|
+
- `details`
|
|
232
|
+
|
|
233
|
+
**Plugin API Properties:**
|
|
234
|
+
- `eventId` (string) - The ID of the event currently applied on the plugin's host
|
|
235
|
+
|
|
236
|
+
---
|
|
237
|
+
|
|
238
|
+
## Multiple Placements
|
|
239
|
+
|
|
240
|
+
You can configure a single plugin to appear in multiple slots:
|
|
241
|
+
|
|
242
|
+
```typescript
|
|
243
|
+
placements: [
|
|
244
|
+
{
|
|
245
|
+
appDefinitionId: '1380b703-ce81-ff05-f115-39571d94dfcd',
|
|
246
|
+
widgetId: '13a94f09-2766-3c40-4a32-8edb5acdd8bc',
|
|
247
|
+
slotId: 'product-page-details-2',
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
appDefinitionId: 'a0c68605-c2e7-4c8d-9ea1-767f9770e087',
|
|
251
|
+
widgetId: '6a25b678-53ec-4b37-a190-65fcd1ca1a63',
|
|
252
|
+
slotId: 'product-page-details-2',
|
|
253
|
+
},
|
|
254
|
+
]
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
**Note:** If you have multiple placements for slots on a single page, the plugin will be added to the first available slot according to the order you defined. If that slot is occupied, it will be placed in the next available slot. If there are no available slots, it will not be placed. Users may manually move the plugin to their desired location in the editor.
|
|
258
|
+
|
|
259
|
+
## Slot Limitations
|
|
260
|
+
|
|
261
|
+
- Each slot has specific size constraints defined by the host app
|
|
262
|
+
- Some slots may only be available in certain editor types (Wix Editor, Editor X, Wix Studio)
|
|
263
|
+
- Multiple plugins can occupy the same slot, displayed next to each other and ordered by creation date
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: wix-design-system
|
|
3
|
+
description: Wix Design System component reference. Use when building UI with @wix/design-system, choosing components, checking props and examples, or writing tests with component testkits. Triggers on "what component", "how do I make", "WDS", "show me props", "testkit", "driver", or component names like Button, Card, Modal, Box, Text.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# WDS Documentation Navigator
|
|
7
|
+
|
|
8
|
+
**Prerequisite:** `@wix/design-system` must be installed (`npm i @wix/design-system` or `yarn add @wix/design-system`).
|
|
9
|
+
|
|
10
|
+
## Helper Script
|
|
11
|
+
|
|
12
|
+
This skill bundles `scripts/wds.cjs` — a Node.js helper that auto-discovers `@wix/design-system` in node_modules (handles monorepos and workspaces) and provides focused lookups. Run it from the user's project directory using the absolute path to the bundled script:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
# WDS is the absolute path to this skill's scripts/wds.cjs
|
|
16
|
+
WDS="<this-skill-dir>/scripts/wds.cjs"
|
|
17
|
+
|
|
18
|
+
node $WDS search <keyword> # Find components by keyword
|
|
19
|
+
node $WDS component <Name> # Get props + example list (one component)
|
|
20
|
+
node $WDS components <Name1> <Name2>... # Same as `component`, but for several at once
|
|
21
|
+
node $WDS example <Name> "<ExampleName>" # Get a specific example
|
|
22
|
+
node $WDS testkit <Name> [method] # Get testkit imports + driver API
|
|
23
|
+
node $WDS icons <query> # Search for icons
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Workflow
|
|
27
|
+
|
|
28
|
+
### Step 1: Find the right component
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
node $WDS search table
|
|
32
|
+
node $WDS search form input validation
|
|
33
|
+
node $WDS search modal dialog popup
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Multiple keywords are OR-matched. Returns component names, descriptions, and usage guidance.
|
|
37
|
+
|
|
38
|
+
### Step 2: Get props and available examples
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
node $WDS component Button
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Returns the full props list (types and descriptions) plus a list of all available examples. For large prop files (>200 lines), returns a summary with prop names and types.
|
|
45
|
+
|
|
46
|
+
If you already know which several components you'll need (e.g. after Step 1 returned a shortlist), prefer the batch form to avoid one round-trip per component:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
node $WDS components Button Card Table Input Text Thumbnail
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Output is each component's props block separated by `---`. Missing components are logged to stderr and skipped; the command only fails if every requested component is missing.
|
|
53
|
+
|
|
54
|
+
### Step 3: Get a specific example
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
node $WDS example Button "Loading state"
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Returns the example description and JSX code. Matching is case-insensitive and supports substrings (e.g., "loading" matches "Loading state").
|
|
61
|
+
|
|
62
|
+
### Step 4: Write tests with the component testkit
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
node $WDS testkit Button # Imports + full driver API for Button
|
|
66
|
+
node $WDS testkit Button click # Just the click() method details
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Returns import snippets for unidriver, vanilla, puppeteer, and playwright flavors plus the driver method API (name, args, return type, description). Method name matching is case-insensitive substring.
|
|
70
|
+
|
|
71
|
+
### Step 5: Find icons
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
node $WDS icons Add Edit Delete
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Icons are from `@wix/wix-ui-icons-common`. Each icon has a `Small` variant (e.g., `Add` + `AddSmall`).
|
|
78
|
+
|
|
79
|
+
## Fallback: Direct File Access
|
|
80
|
+
|
|
81
|
+
If the script is unavailable, docs are at `node_modules/@wix/design-system/dist/docs/`:
|
|
82
|
+
|
|
83
|
+
- `components.md` — component catalog (~978 lines, grep only)
|
|
84
|
+
- `components/{Name}Props.md` — props per component
|
|
85
|
+
- `components/{Name}Examples.md` — examples per component (grep `^### ` for section list)
|
|
86
|
+
- `components/{Name}Testkit.md` — testkit imports + driver API per component (grep `^### ` for method list)
|
|
87
|
+
- `testkits.md` — testkit catalog (list of components with generated testkit docs)
|
|
88
|
+
- `icons.md` — icon catalog (~818 lines, grep only)
|
|
89
|
+
|
|
90
|
+
Don't read these files fully. Grep for keywords, then read specific sections with offset/limit. See [references/file-structure.md](references/file-structure.md) for the exact docs file layout and section shapes.
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## Quick Component Mapping (Design to WDS)
|
|
95
|
+
|
|
96
|
+
| Design Element | WDS Component | Notes |
|
|
97
|
+
| --- | --- | --- |
|
|
98
|
+
| Rectangle/container | `<Box>` | Layout wrapper |
|
|
99
|
+
| Text button | `<TextButton>` | Secondary actions |
|
|
100
|
+
| Input with label | `<FormField>` + `<Input>` | Wrap inputs |
|
|
101
|
+
| Toggle | `<ToggleSwitch>` | On/off settings |
|
|
102
|
+
| Modal | `<Modal>` + `<CustomModalLayout>` | Use together |
|
|
103
|
+
| Grid | `<Layout>` + `<Cell>` | Responsive |
|
|
104
|
+
|
|
105
|
+
## Spacing (px to SP conversion)
|
|
106
|
+
|
|
107
|
+
When designer specifies pixels, convert to the nearest SP token:
|
|
108
|
+
|
|
109
|
+
| Token | Classic | Studio |
|
|
110
|
+
| --- | --- | --- |
|
|
111
|
+
| `SP1` | 6px | 4px |
|
|
112
|
+
| `SP2` | 12px | 8px |
|
|
113
|
+
| `SP3` | 18px | 12px |
|
|
114
|
+
| `SP4` | 24px | 16px |
|
|
115
|
+
| `SP5` | 30px | 20px |
|
|
116
|
+
| `SP6` | 36px | 24px |
|
|
117
|
+
|
|
118
|
+
```tsx
|
|
119
|
+
<Box gap="SP2" padding="SP3">
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Only use SP tokens for `gap`, `padding`, `margin` — not for width/height.
|
|
123
|
+
|
|
124
|
+
## Imports
|
|
125
|
+
|
|
126
|
+
```tsx
|
|
127
|
+
import { Button, Card, Image } from "@wix/design-system";
|
|
128
|
+
import { Add, Edit, Delete } from "@wix/wix-ui-icons-common";
|
|
129
|
+
```
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# WDS Docs File Structure
|
|
2
|
+
|
|
3
|
+
All files are under `node_modules/@wix/design-system/dist/docs/`.
|
|
4
|
+
|
|
5
|
+
## Example File Format
|
|
6
|
+
|
|
7
|
+
````markdown
|
|
8
|
+
## Feature Examples
|
|
9
|
+
|
|
10
|
+
### ExampleName
|
|
11
|
+
|
|
12
|
+
- description: What it shows
|
|
13
|
+
- example:
|
|
14
|
+
|
|
15
|
+
```jsx
|
|
16
|
+
<Component prop="value">Content</Component>
|
|
17
|
+
```
|
|
18
|
+
````
|
|
19
|
+
|
|
20
|
+
## Props File Format
|
|
21
|
+
|
|
22
|
+
```markdown
|
|
23
|
+
### propName
|
|
24
|
+
- type: TypeDefinition
|
|
25
|
+
- description: What it does
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Testkit File Format
|
|
29
|
+
|
|
30
|
+
`components/{Name}Testkit.md`:
|
|
31
|
+
|
|
32
|
+
```markdown
|
|
33
|
+
## {Name} Testkit
|
|
34
|
+
|
|
35
|
+
### Import
|
|
36
|
+
|
|
37
|
+
- unidriver: `import { {Name}UniDriver } from '@wix/design-system/dist/testkit/unidriver';`
|
|
38
|
+
- vanilla: `import { {Name}Testkit } from '@wix/design-system/dist/testkit';`
|
|
39
|
+
- puppeteer: `import { {Name}Testkit } from '@wix/design-system/dist/testkit/puppeteer';`
|
|
40
|
+
- playwright: `import { {Name}Testkit } from '@wix/design-system/dist/testkit/playwright';`
|
|
41
|
+
|
|
42
|
+
### API
|
|
43
|
+
|
|
44
|
+
### methodName
|
|
45
|
+
- signature: methodName(arg)
|
|
46
|
+
- returns: Promise<ReturnType>
|
|
47
|
+
- description: What it does
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Common Components
|
|
51
|
+
|
|
52
|
+
### High-traffic (learn these patterns)
|
|
53
|
+
|
|
54
|
+
- Button, Input, FormField, Dropdown
|
|
55
|
+
- Table, Card, Page, Modal
|
|
56
|
+
- Box, Layout, Cell
|