Phase 2: Schema-Based Form System
- Add ModuleSettingsController with GET/POST/schema endpoints
- Create SchemaField component supporting 8 field types (text, textarea, email, url, number, toggle, checkbox, select)
- Create SchemaForm component for automatic form generation from schema
- Add ModuleSettings page with dynamic routing (/settings/modules/:moduleId)
- Add useModuleSettings React hook for settings management
- Implement NewsletterSettings as example with 8 configurable fields
- Add has_settings flag to module registry
- Settings stored as woonoow_module_{module_id}_settings
Phase 3: Advanced Features
- Create windowAPI.ts exposing React, hooks, components, icons, utils to addons via window.WooNooW
- Add DynamicComponentLoader for loading external React components
- Create TypeScript definitions (woonoow-addon.d.ts) for addon developers
- Initialize Window API in App.tsx on mount
- Enable custom React components for addon settings pages
Phase 4: Production Polish & Example
- Create complete Biteship addon example demonstrating both approaches:
* Schema-based settings (no build required)
* Custom React component (with build)
- Add comprehensive README with installation and testing guide
- Include package.json with esbuild configuration
- Demonstrate window.WooNooW API usage in custom component
Bug Fixes:
- Fix footer newsletter form visibility (remove redundant module check)
- Fix footer contact_data and social_links not saving (parameter name mismatch: snake_case vs camelCase)
- Fix useModules hook returning undefined (remove .data wrapper, add fallback)
- Add optional chaining to footer settings rendering
- Fix TypeScript errors in woonoow-addon.d.ts (use any for external types)
Files Added (15):
- includes/Api/ModuleSettingsController.php
- includes/Modules/NewsletterSettings.php
- admin-spa/src/components/forms/SchemaField.tsx
- admin-spa/src/components/forms/SchemaForm.tsx
- admin-spa/src/routes/Settings/ModuleSettings.tsx
- admin-spa/src/hooks/useModuleSettings.ts
- admin-spa/src/lib/windowAPI.ts
- admin-spa/src/components/DynamicComponentLoader.tsx
- types/woonoow-addon.d.ts
- examples/biteship-addon/biteship-addon.php
- examples/biteship-addon/src/Settings.jsx
- examples/biteship-addon/package.json
- examples/biteship-addon/README.md
- PHASE_2_3_4_SUMMARY.md
Files Modified (11):
- admin-spa/src/App.tsx
- admin-spa/src/hooks/useModules.ts
- admin-spa/src/routes/Appearance/Footer.tsx
- admin-spa/src/routes/Settings/Modules.tsx
- customer-spa/src/hooks/useModules.ts
- customer-spa/src/layouts/BaseLayout.tsx
- customer-spa/src/components/NewsletterForm.tsx
- includes/Api/Routes.php
- includes/Api/ModulesController.php
- includes/Core/ModuleRegistry.php
- woonoow.php
API Endpoints Added:
- GET /woonoow/v1/modules/{module_id}/settings
- POST /woonoow/v1/modules/{module_id}/settings
- GET /woonoow/v1/modules/{module_id}/schema
For Addon Developers:
- Schema-based: Define settings via woonoow/module_settings_schema filter
- Custom React: Build component using window.WooNooW API, externalize react/react-dom
- Both approaches use same storage and retrieval methods
- TypeScript definitions provided for type safety
- Complete working example (Biteship) included
WooNooW Customer SPA
Modern React-based storefront and customer portal for WooNooW.
Features
- Product Catalog - Browse products with filters and search
- Shopping Cart - Add to cart with real-time updates
- Checkout - Single-page checkout with address autocomplete
- My Account - Order history, profile, and addresses
- Mobile-First - Responsive design for all devices
- PWA Ready - Offline support and app-like experience
Development
# Install dependencies
npm install
# Start dev server (https://woonoow.local:5174)
npm run dev
# Build for production
npm run build
# Preview production build
npm run preview
# Lint code
npm run lint
Project Structure
customer-spa/
├── src/
│ ├── pages/ # Page components (Shop, Cart, Checkout, Account)
│ ├── components/ # Reusable UI components
│ ├── lib/
│ │ ├── api/ # API client and endpoints
│ │ ├── cart/ # Cart state management (Zustand)
│ │ ├── checkout/ # Checkout logic
│ │ └── tracking/ # Analytics and pixel tracking
│ ├── hooks/ # Custom React hooks
│ ├── contexts/ # React contexts
│ └── types/ # TypeScript type definitions
├── public/ # Static assets
└── dist/ # Build output (generated)
Tech Stack
- React 18 - UI framework
- TypeScript - Type safety
- Vite - Build tool
- React Router - Routing
- TanStack Query - Data fetching
- Zustand - State management
- TailwindCSS - Styling
- shadcn/ui - UI components
- React Hook Form - Form handling
- Zod - Schema validation
API Integration
The SPA communicates with WordPress via REST API endpoints:
/wp-json/woonoow/v1/shop/*- Product catalog/wp-json/woonoow/v1/cart/*- Shopping cart/wp-json/woonoow/v1/checkout/*- Checkout process/wp-json/woonoow/v1/account/*- Customer account
Deployment Modes
1. Shortcode Mode (Default)
Works with any WordPress theme via shortcodes:
[woonoow_shop][woonoow_cart][woonoow_checkout][woonoow_account]
2. Full SPA Mode
Takes over entire frontend for maximum performance.
3. Hybrid Mode
SSR for product pages (SEO), SPA for cart/checkout/account.
SEO & Tracking
- SEO-Friendly - Server-side rendering for product pages
- Analytics - Google Analytics, GTM support
- Pixels - Facebook, TikTok, Pinterest pixel support
- PixelMySite - Full compatibility
License
Proprietary - Part of WooNooW plugin