Skip to main content

propeller-v2-vue-ui

A Vue 3 component library for Propeller Commerce storefronts. It ships ready-made e-commerce UI — product cards, grids, carts, checkout, account pages — together with headless composables that talk to the Propeller GraphQL API, plus the shared utilities and types those parts build on.

It is the Vue mirror of propeller-v2-react-ui: same component set, same SDK seam, same styling contract.

The package runs in any Vue 3.4+ app — a Vite SPA, a Nuxt 3 app — and ships its own precompiled stylesheet, so you do not need Tailwind in your project to use it.

What's here​

  • Getting started — install, peer dependencies, and a first render.
  • The SDK seam — the one architectural idea you must understand: the consumer owns the GraphQL client.
  • Styling — the three ways to override the look.
  • Nuxt & SSR — how the package behaves under server-side rendering.
  • API integration — how the composables reach the Propeller GraphQL backend, domain by domain.
  • Component reference — the catalogue of components, grouped, with a link into Storybook for live examples and prop tables.
  • API reference — the generated TypeDoc reference for the composables, the provider, the SDK seam, and the shared utilities/types.
  • Storybook — the component workbench.
  • Contributing — for developers working on the package itself.

Status​

The package is pre-1.0 (0.x). The public API may change between minor versions until it stabilises; breaking changes are documented in the package's MIGRATION.md.