Index of every page on this site: llms.txt
All skills
wix avatar

/wix-app

@e2bc48e official
by Wix.comwix/skills40 stars
42
Run it yourself

Build and review Wix CLI app extensions — dashboard pages, modals, plugins, menu plugins, custom element widgets, Editor React components, site plugins, embedded scripts, context providers, function libraries, lightbox (popup) behavior, page onLoad contexts, backend APIs, backend events, service plugins, data collections, and App Market readiness. Use when building ANY feature or extension for a Wix CLI app or preparing a Wix app for App Market review. Triggers on: add, build, create, implement, help me, dashboard, widget, plugin, backend, API, event, collection, embedded script, service plugin, Editor React component, context provider, function library, onLoad, on page load, checkout, shipping, tax, discount, SPI, CMS, schema, tracking, popup, lightbox, admin panel, menu item, modal, validate, test, verify, register extension, App Market, app review, submission readiness.

Use this Skill: https://skilld.dev/gh/wix/skills/wix-app

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencescontext-providervertical-contextsbookingsbooking-checkout.md

≈1.4k tokens on demand. Your agent reads this file only when SKILL.md points to it.

Bookings context: @wix/bookings/context/booking-checkout

Read Importing a Context in Code first. Import only the hook, from @wix/bookings/context/booking-checkout.

BookingCheckoutContextProvider

Decodes the booking selection from the page URL and lets descendants book it or add it to the cart.

import { BookingCheckoutContextProvider } from '@wix/bookings/context/booking-checkout';
  • Parameters: __0: BookingCheckoutContextProviderProps
  • Returns: Element

canBookSelection

import { canBookSelection } from '@wix/bookings/context/booking-checkout';
  • Parameters: selection: BookingPreferences \| null
  • Returns: boolean

useBookingCheckoutContext

Reads the booking checkout state; returns null instead of throwing when optional is true and no provider is above.

import { useBookingCheckoutContext } from '@wix/bookings/context/booking-checkout';
  • Parameters: optional: true
  • Returns: BookingCheckoutState \| null
Returned types
BookingCheckoutContextProviderProps
Property Type Description
children ReactNode
BookingPreferences
Property Type Description
mode BookingMode
timezone string | null | undefined
services ServicePreference[]
wantsPromoCode boolean | undefined The visitor ticked "I have a coupon" in the Booking Summary, so checkout must not be skipped. Absent means unticked; writers omit false.
BookingCheckoutState
Property Type Description
selection BookingPreferences | null Null when the page has no usable b=.
canBook boolean Every entry passes canBookSelection and a booking form is registered.
planAndBookFlow PlanAndBookFlow The button the visitor sees and where createBooking sends them, from the selected rows.
selectedPaymentOptions (PaymentOption$1 | null)[] | null Null without resolved payment choices for the current selection.
isLoadingPaymentOptions boolean
registerPaymentOptions (options: (PaymentOption$1 | null)[] | null, isPlanAndBookBlocked: boolean) => () => void Publish prices independently of form validation; null means payment options are loading.
hasCartConflict boolean From the registered form.
registerForm (form: BookingFormHandle | null) => void The form registers on mount and passes null on unmount.
formFacts FormFacts | null Published by the form; null until it is usable.
publishFormFacts (facts: FormFacts | null) => void The form publishes its facts for the widgets beside it (Booking Summary); null on unmount.
isFormEmptyState boolean The form shows legacy's empty state in place of itself, so Book and Add to Cart hide, as legacy's did with it.
publishFormEmptyState (isEmptyState: boolean) => void The form publishes it while its empty state shows; false on unmount.
createBooking () => Promise<CreateBookingOutcome> Validates, creates the booking(s) and cart, then places the order or goes to checkout. One run at a time.
isCreating boolean Stays true on success while the checkout or thank-you page loads.
createError CheckoutError | null The last failure; cleared by the next Book or Add to Cart, a changed selection or participant count.
addToCart (destination?: AddToCartDestination | undefined) => Promise<AddToCartOutcome> Validates the form, creates the booking(s), adds them to the visitor's current cart and goes to destination (the cart page by default). Shares the guard with createBooking.
isAddingToCart boolean True from the click until a failure or a stay; stays true on success while the next page loads.
addToCartError CheckoutError | null As createError, for Add to Cart.
participants number Participants for a single service without variants; 1 by default. Booked as totalParticipants.
setParticipants (count: number) => void Takes an integer of at least 1 (anything else books 1). Uncapped: as legacy, a max that drops later leaves it.
lastResult BookingCheckoutResult | null For QA in the console.
PlanAndBookFlow
Property Type Description
cta PlanAndBookCta
route PlanAndBookRoute
FormFacts
Property Type Description
payments { serviceId: string | null; paymentOption: BookingPaymentOption; hasPrice: boolean; }[] How the visitor pays each booked service.
hasBookingsInCart boolean Bookings lines only, as in OOI's isServiceInCart.
participantsPrice PreviewedParticipantsPrice | undefined Rule-based pricing only: the previewed price of the picked count and slot.
CheckoutError
Property Type Description
code string applicationError.code, or UNKNOWN_CHECKOUT_ERROR without one.
violation string | undefined The first violation's text, which eCom sends with VIOLATIONS_WITH_ERROR_SEVERITY.
BookingCheckoutResult
Property Type Description
bookingIds string[]
cartId string

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

2 warningstoday4 checks · Risk SAFE
  • Gen Agent Trust Hubtoday

    This skill provides a comprehensive environment and set of tools for building Wix CLI app extensions. It includes detailed instructions, API references, and local utility scripts for development tasks like SDK lookup and accessibility auditing. All operations and dependencies are standard for the Wix developer platform.

  • Sockettoday

    1 alert: gptAnomaly

  • Snyktoday

    Risk: MEDIUM · 1 issue

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at e2bc48e. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 6 days ago
compatibility
requires `@wix/cli` >= 1.1.192.

README badge

README badge for wix/skills/wix-app

Builds dashboard pages, modals, plugins, custom widgets, Editor React components, backend APIs, events, service plugins, and data collections for Wix CLI apps. Provides decision logic, API patterns, and validation workflows; scaffolding is owned by the Wix CLI via `wix generate --params`.

Generated from the current SKILL.md.

What extension types does this skill cover?
All Wix CLI app extension types: dashboard pages, modals, plugins, menu plugins, custom element widgets, Editor React components, site plugins, embedded scripts, backend APIs, backend events, service plugins, and data collections.
Does this skill scaffold the extension files for me?
The Wix CLI owns scaffolding via `wix generate --params` for all extension types except Backend API. This skill provides decision logic, API guidance, and business-logic patterns to fill in the generated stubs. Backend API files must be created manually.
What Wix CLI version is required?
The skill requires @wix/cli >= 1.1.192.
Do I need to create a Data Collection extension for app-specific data?
Yes, if you're saving or persisting app-specific data, managing domain entities in a dashboard, or running a service plugin that reads app-configured data. The skill infers this automatically—you don't need to explicitly request it.
Does this skill cover Wix Stores API usage?
Yes. When using any Wix Stores API (products, inventory, orders), the skill requires dual V1/V3 catalog support and references the Stores Versioning guide for module selection and field mapping.

Generated from the current SKILL.md. These answers refresh after source changes.