All skills
wix avatar

/wix-vibe-headless

@1563591 official
by Wix.comwix/skills33 stars
33

Client-only, dependency-free REST scaffolds for connecting an already-built front end (a vibe-coded app, an HTML/JSX/Vite project, a design-tool export) to a live Wix site over the site's public WIX_CLIENT_ID — the browser talks to Wix directly, no SDK, no backend, no build step. One skill covering every Wix business solution: Stores/eCommerce storefront (products, cart, checkout), Bookings (services, slots, appointments), Blog (posts, categories, tags), Events & Tickets (browse, RSVP, ticketing), Portfolio (collections, projects, galleries), Restaurants (menu, online ordering, reservations), Forms (any visitor-fillable form — contact/enquiry, signup, waitlist, application, survey, quote request; schema-driven render + submit), CMS / Wix Data (list, detail, filter, CRUD), Pricing Plans (memberships, subscriptions, checkout), and Members (custom login — email+password, Google/Facebook, and custom SSO — plus account areas and member-gated content). Each vertical ships a copy-as-is REST layer plus wiring instructions. Read-only over the owner's content — never provisions, never mocks data. Triggers: connect my Wix store/shop, build a storefront over Wix, add a cart and checkout, connect Wix Bookings, take appointments/reservations, show my Wix blog, list my Wix events, sell tickets, take RSVPs, build a portfolio from Wix Portfolio, show my restaurant menu / order online / book a table, display my Wix CMS collection, wire a contact form to Wix, add a contact/enquiry form, build a signup or application form, take survey responses, sell membership/subscription plans, add member login / sign up, let members log in with Google or Facebook, custom login page, account / profile page, gate content behind login, sign in with SSO/Okta, 'here is my WIX_CLIENT_ID', connect this app to my Wix site over REST. Use this for CLIENT-ONLY REST integration over an existing site; use `wix-headless` instead for SDK + Wix CLI builds, hosting, and one-prompt new-site creation.

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

This session only. Nothing lands on disk.

referencesrestaurantsINSTRUCTIONS.md

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

Wix Restaurants — ready-made client

The restaurant client is shipped as real files, not snippets to regenerate. It's a complete menu + item ordering + server-cart + checkout, plus a table-reservation flow, styled with your app's design tokens (base44's src/index.css — the shadcn palette the design phase already set). Copy it into the app and wire the routes — you generate almost none of the restaurant code (the menu tree join, the order cart, the reservation hold→reserve flow all ship and are correct).

Talks to Wix directly over the public WIX_CLIENT_ID (anonymous visitor tokens). Never mock the menu; never hand-build /checkout or reservation URLs — the shipped cart goes through the eCom redirect-session and reservations go through the hold/reserve flow.

Prerequisites

  • The site's Wix Restaurants Menus app is the read target for the menu; Restaurant Orders backs online ordering; Table Reservations backs the booking page. They're installed and seeded separately (see Seeding below), in parallel with this build — so the menu may be empty and ordering / reservations may be unconfigured at build time. The client renders the shipped empty / "unavailable" states until content and operations land.
  • The public headless WIX_CLIENT_ID from your prompt (buyer-facing, safe to hardcode/commit).
  • For Wix-hosted checkout to return, the deployed app domain must be allow-listed on the OAuth client — a separate Wix setup the user completes later, out of scope here. If checkout return fails before that, it's expected; flag it and continue.

STEP 1 — The client is already in src/

The install step (base44.md STEP 1) deployed the whole restaurant UI client + REST scaffolds into src/ (imports use the @/ alias → src/). Here's every file and what it is — this is your map, so you don't need to open them:

file what it is
context/OrderCartContext.jsx useOrderCart() provider: resolves the ordering Operation, server cart, add/update/remove, checkout, ordering flag
hooks/useItemOrder.js item-dialog add-to-order logic (stock + ordering-available gating, quantity)
hooks/useReservation.js reservation flow (locations → date/party → AVAILABLE slots → hold → reserve)
components/MenuItemCard.jsx, MenuList.jsx menu render UI (dish card + the menus→sections→items tree, with empty state)
components/ItemDialog.jsx dish detail modal — description, price/variants, modifier groups (display), quantity, add-to-order
components/OrderCartButton.jsx header order icon button with a live-count badge
components/OrderCartDrawer.jsx slide-over order cart (mount once; opens from useOrderCart)
components/WixManageBanner.jsx preview-only manage banner — drop it into your Layout (STEP 3)
pages/Menu.jsx, pages/Reservations.jsx the two shipped routes (/menu, /reservations)
rest/wix-config.js the two ids, written by the install step
rest/wix-client.js REST transport + visitor-token mint/refresh (the refresh token IS the cart identity)
rest/wix-restaurants-menu.js menu read helpers — getFullMenu (the assembled tree; start here) + raw list*
rest/wix-restaurants-ordering.js ordering — operations, add/update/remove, checkout
rest/wix-restaurants-reservations.js reservations — locations, time slots, hold, reserve

They're already in place — go straight to theming + wiring, nothing to verify first. Don't read_file the shipped page/component/hook source to inspect it — the table above says what each is and every field shape you need is in the snippets below. Read a shipped file's source only on a real fallback — a runtime error, or a field the snippets don't cover (see "Fallback only" at the end). (Files missing? the install's deploy result lists what it wrote; re-run install, or copy references/restaurants/app/ → src/.)

STEP 2 — Theme

Use the existing Base44 theme in src/index.css so your pages and the shipped components share the same colors and typography.

STEP 3 — Wire routes + provider (surgical find_replace on src/App.jsx, never a rewrite)

The template decides this step, and src/routes/__root.jsx is the question to ask first. Present → TanStack Start, which mounts these pages as route files at the end of this step; absent → React Router, which the wiring below is written for. Ask in that order: an src/App.jsx can exist on a TanStack app because an agent created one, and __root.jsx is never there by mistake. The installed src/lib/nav.js defaults to the React Router adapter, so on TanStack swap it: both patterns.

Import Link, useParams and friends from @/lib/nav in the pages you write too — same names as the router exports, and nothing you write is pinned to one template.

No file reads needed to wire this. Every shipped page and WixManageBanner is a default export that takes no props — wire them exactly as the snippet shows; nothing in those files needs looking up. App.jsx carries required platform auth scaffolding (AuthProvider/useAuth) — edit it in, don't replace it.

  • Wrap the routed tree in <OrderCartProvider> (from @/context/OrderCartContext).
  • Put your header + footer in a Layout that renders <Outlet/> between them, and nest every route under one pathless <Route element={<Layout/>}>. Your brand chrome then wraps every page — including the shipped Menu / Reservations — so you never edit the shipped pages to add a header/footer (they render inside <Outlet/> as-is). Mount <OrderCartDrawer/> once in the Layout.
  • Pin the top chrome as one fixed block. Put <WixManageBanner/> (shipped, preview-only) above your <Header/> inside a single position:fixed top region — the header itself is plain in-flow markup, the region owns the fixing — so banner + header ride together (no scroll drift/gap). Pad the content by the region's measured height so it clears the chrome and self-corrects when the banner is dismissed.
  • Routes under the Layout: /menu → Menu, /reservations → Reservations (both shipped, as-is). You add / → your own Home page.
import { useRef, useState, useEffect } from "react";
import { Routes, Route, Outlet } from "react-router-dom";
import { OrderCartProvider } from "@/context/OrderCartContext";
import OrderCartDrawer from "@/components/OrderCartDrawer";
import WixManageBanner from "@/components/WixManageBanner";   // shipped, preview-only · default export, no props
import Menu from "@/pages/Menu";                       // shipped · default export, no props
import Reservations from "@/pages/Reservations";       // shipped · default export, no props
import Home from "@/pages/Home";       // YOU build
import Header from "@/components/Header";   // YOU build — plain in-flow markup, NOT position:fixed
import Footer from "@/components/Footer";   // YOU build

function Layout() {
  const topRef = useRef(null);
  const [offset, setOffset] = useState(0);
  useEffect(() => {                                  // measure the fixed region → pad content below it
    const ro = new ResizeObserver(() => setOffset(topRef.current?.offsetHeight ?? 0));
    if (topRef.current) ro.observe(topRef.current);
    return () => ro.disconnect();
  }, []);
  return (<>
    <div ref={topRef} style={{ position: "fixed", top: 0, left: 0, right: 0, zIndex: 50 }}>
      <WixManageBanner />                    {/* null on the published site / when dismissed */}
      <Header />                             {/* your brand header, in-flow inside this fixed block */}
    </div>
    <div style={{ paddingTop: offset }}>     {/* clears the chrome; shrinks when the banner is dismissed */}
      <Outlet />                             {/* shipped Menu/Reservations render here, untouched */}
      <Footer />
    </div>
    <OrderCartDrawer />                       {/* overlays every page */}
  </>);
}

<OrderCartProvider>
  <Routes>
    <Route element={<Layout />}>                                {/* chrome wraps all */}
      <Route path="/" element={<Home />} />                     {/* yours */}
      <Route path="/menu" element={<Menu />} />                 {/* shipped, as-is */}
      <Route path="/reservations" element={<Reservations />} /> {/* shipped, as-is */}
    </Route>
  </Routes>
</OrderCartProvider>

TanStack Start template — the same pages, mounted as files

Chrome (header, footer, the fixed banner region described above) goes in src/routes/__root.jsx around its <Outlet/>, and any provider this vertical asks for wraps that <Outlet/> once. Each route is a two-line file; shipped pages stay in src/pages/ untouched.

route file component
/ src/routes/index.jsx Home
/menu src/routes/menu.jsx Menu
/reservations src/routes/reservations.jsx Reservations
// src/routes/menu.jsx
import { createFileRoute } from "@tanstack/react-router";
import Menu from "@/pages/Menu";

export const Route = createFileRoute("/menu")({ component: Menu });

Path params are $name in both the filename and the route path; useParams() from @/lib/nav reads them unchanged. Full pattern, including ssr: false for per-user routes: ../_shared/routing.md.

What you build (not shipped)

The home / landing page, the Header (mount <OrderCartButton/> in it) and a Footer — the two you drop into the Layout (STEP 3) so they wrap every route — plus the overall brand story, styled with the same base44 tokens/classes. The nav is an <OrderCartButton/> (a clean order-icon button with a live-count badge — render it as-is, don't wrap it in your own text button) + links to /menu and /reservations:

import { useState, useEffect } from "react";
import { Link } from "react-router-dom";
import OrderCartButton from "@/components/OrderCartButton";

// Responsive header: choose ONE branch with a state flag, so <OrderCartButton/> mounts once.
// Do NOT render a desktop nav AND a mobile nav toggled by `hidden md:flex` / `md:hidden`:
// these navs are inline-styled, and an inline `display` beats a Tailwind class, so `hidden`
// never applies — BOTH branches render and you get two order buttons. One branch = one button.
export function Header() {
  const [mobile, setMobile] = useState(() => window.innerWidth < 768);
  useEffect(() => {
    const onResize = () => setMobile(window.innerWidth < 768);
    window.addEventListener("resize", onResize);            // keep it reactive to viewport changes
    return () => window.removeEventListener("resize", onResize);
  }, []);
  return (
    <nav style={{ display: "flex", alignItems: "center", justifyContent: "space-between" }}>
      {/* brand/logo */}
      {mobile
        ? <YourMenu />                                       // your hamburger + <OrderCartButton/> here
        : <div style={{ display: "flex", gap: 24, alignItems: "center" }}>
            <Link to="/menu">Menu</Link><Link to="/reservations">Reserve</Link><OrderCartButton />
          </div>}
    </nav>
  );
}

Everything visual reads base44's design tokens (index.css), so your home/nav match the shipped pages automatically. <OrderCartButton/> is an icon button (live-count badge) — drop it in as-is, it inherits currentColor.

Editing a component and the change doesn't show? It's the preview, not your code. The dev preview can serve a stale module after a write. Before diagnosing a visual bug you just "fixed", do a fresh full navigate/reload of the preview and re-check — don't keep rewriting correct code against a stale render.

Using the client from your own UI (menu, order cart)

Migrating from Cart V1 / Checkout V1? These helpers are V2-only — see the migration guide for the before/after.

import { getFullMenu } from "@/rest/wix-restaurants-menu";
import { useOrderCart } from "@/context/OrderCartContext";

// getFullMenu() is the ONLY pre-joined shape and the entry point for any menu surface. It returns
// { menus: [{ ...menu, sections: [{ ...section, items: [assembledItem] }] }] }, already ordered.
// Each item is enriched with a resolved price / variants, modifierGroups, and labels.
const { menus } = await getFullMenu();            // [] when no menus → show the shipped empty state

// useOrderCart() gives:
// { cart, operation, ordering, itemCount, isOpen, setIsOpen, loading,
//   addItem(item, { menuId, sectionId }, qty=1),   // needs the menu/section the item was shown under
//   removeItem(lineItemId), updateQuantity(lineItemId, qty), checkout(), refreshCart() }
// `ordering` is false when no ordering Operation is configured — show an "ordering unavailable" state.

// Load-bearing field paths (the shipped components already do these):
// - item.image / section.image / label.icon are OBJECTS → render `.url`, never the object; //-urls → https:
// - MENU prices are plain decimal strings with NO currency symbol ("12.50") — format in the UI.
//   The eCom cart line price (line.pricing.unitPrice / line.pricing.totalPrice) is a ConvertedMoney
//   { amount, convertedAmount } with NO symbol either — format the number yourself.
// - an item is priced by EITHER item.price (single) OR item.variants[] (one-of, each { name, price }).
// - a cart mutation uses cart.lineItems[].id (the lineItemId), NOT the menu item id.

Buying happens in the shipped ItemDialog (opened from MenuList) — it owns quantity + add-to-order and surfaces out-of-stock / ordering-unavailable errors. Compose a featured strip on your Home from getFullMenu() + the shipped MenuItemCard if you want.

Extending the client

Building something beyond the shipped pages, or need a path these snippets don't cover?

// The raw list* helpers return UNRESOLVED refs and INCONSISTENT shapes (listMenus → { menus,
// nextCursor }; listSections/listItems/listVariants/listModifierGroups/listModifiers → bare arrays).
// Don't re-join them by hand — build on getFullMenu(). If you truly need a partial fetch, note they
// take an array of GUIDs: listSections(sectionIds), listItems(itemIds).

// Reservation status after reserve: RESERVED = confirmed, REQUESTED = manual approval pending
// (tell the user). firstName + phone (E.164, e.g. "+15551234567") are mandatory; a HELD reservation
// expires in 10 minutes — the hook passes the hold's { id, revision } into reserve for you.

Modifier up-charges / price-variant selection / special requests on the cart line are not wired into addItemToCart — the restaurants catalogReference.options shape for these isn't documented for client add-to-cart, so ItemDialog displays modifier groups for the diner but sends only quantity. To wire them, confirm the shape via the documentation skill available in your environment / the reference first, never guess:

Fallback only — when you hit an error or need something not shown here: read the relevant shipped file under src/, or look it up via the documentation skill available in your environment.

Hard rules

  • Header/footer live in a Layout around <Outlet/> (STEP 3) — never edit the shipped Menu/Reservations to add chrome.
  • The Layout's fixed top region owns positioning: <WixManageBanner/> above <Header/>; your Header is plain in-flow markup (not position:fixed).
  • Order through the shipped cart: addItem() → checkout() (redirect-session) — never a hand-built /checkout, ordering, or reservation URL.
  • Reservations: offer only AVAILABLE slots; pass the hold's revision into reserve; firstName + phone (E.164) are mandatory.
  • Render live Wix data or the shipped empty / "unavailable" state — never mock menus, items, prices, operations, locations, slots, or reviews.

Point the user to their dashboard

Provide deep links so the owner can edit content across the apps they actually use (substitute the site's metaSiteId from the handoff / ListWixSites):

  • Menu (always) — https://manage.wix.com/dashboard/{metaSiteId}/wix-restaurants-menus-new (Dashboard → Restaurant Menus; click Manage Items to add dishes; only visible menus appear in the app)
  • Online ordering (if wired) — https://manage.wix.com/dashboard/{metaSiteId}/wix-restaurants-orders-new/settings (Dashboard → Restaurant Orders → Settings). Enable at least one fulfillment method before the site accepts orders: pickup .../wix-restaurants-orders-new/settings/pickup, delivery .../settings/delivery, dine-in .../settings/dine-in.
  • Table reservations (if wired) — https://manage.wix.com/dashboard/{metaSiteId}/wix-table-reservations/table-reservations (Dashboard → Table Reservations → Settings; configure tables, availability, and enable online reservations)

Tell the user at least once that they can keep setting up their restaurant (menu / ordering / reservations) in the dashboard, and include the in-dashboard navigation as a fallback.

Seeding

Seed the menu (and ordering/reservation setup) per seed/SEED.md — separate from this client build; run in parallel.

Verify (before declaring done)

  • Client files copied into src/; WIX_CLIENT_ID set (not the placeholder).
  • Opened /menu and /reservations (not just the home page) and confirmed the shipped components render themed (surface, text, brand) with images.
  • Layout (fixed <WixManageBanner/> + <Header/> region, then <Outlet/> + Footer) wraps all routes; shipped Menu/Reservations untouched; content clears the fixed chrome; <OrderCartProvider> wraps the tree; <OrderCartDrawer/> mounted; <OrderCartButton/> in the header.
  • getFullMenu() renders real sections/items with prices, variants, modifiers, and labels; empty catalog shows the shipped empty state (no mock items).
  • Add to order works with a real operation (or shows "ordering unavailable"); order survives reload (same visitor); update-qty / remove work; checkout redirects and re-fetches on return.
  • Reservations: only AVAILABLE slots offered; hold → reserve produces RESERVED/REQUESTED; no locations shows the shipped empty state.
  • Told the user they can continue setting up in the dashboard, with deep links.

Source: SKILL.md on GitHub

1 warning6d3 checks · Risk SAFE
  • Gen Agent Trust Hub6d

    The skill is safe and provides a comprehensive integration framework for Wix Headless services. It uses platform-secured connectors for authentication and includes automated scaffolding utilities to assist with project setup.

  • Socket6d

    No alerts

  • Snyk6d

    Risk: MEDIUM · 1 issue

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

Last checked against GitHub 42 minutes ago.

Activeupdated 4 weeks ago

README badge

README badge for wix/skills/wix-vibe-headless