npm - @ohhwells/bridge - Versions diffs - 0.1.14 → 0.1.16-next.12 - Mend

@ohhwells/bridge 0.1.14 → 0.1.16-next.12

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.

Files changed (9) hide show

package/README.md CHANGED Viewed

@@ -4,138 +4,266 @@ The OhhWells canvas editor bridge — a standalone npm package that enables inli
 ## What it does
-When a studio owner opens their site in the OhhWells dashboard canvas editor, the bridge:
+When a studio owner opens their site in the OhhWells canvas editor, the bridge:
 - Connects the iframe (the live site) to the parent canvas editor via `postMessage`
 - Enables click-to-edit for text, images, and background images
 - Handles draft saving and content hydration
-- Provides state toggle UI for editing hidden content (hover states, form success/error views)
+- Shows the "Add Section" insert line between sections in the canvas editor
+- Provides state toggle UI for editing hidden content (hover states, form views)
 - Injects scoped styles that never leak into the host template
+---
 ## Installation
 ```bash
 npm install @ohhwells/bridge
 ```
-Import the styles once in your template's root layout:
+---
+## Template setup (required steps)
+### 1. Import styles
+In your root layout file, import the bridge stylesheet **once**:
 ```ts
 import '@ohhwells/bridge/styles'
 ```
-## Usage
+### 2. Add the loader surface
+The loader is a full-screen spinner shown while the bridge fetches personalised content. It hides itself once content is ready. Add this **before** your main content in the `<body>`:
+```tsx
+import { OHW_LOADER_STYLE, OhwLoaderSpinner } from '@ohhwells/bridge'
+// Inside <body>:
+<div
+  id="ohw-loader"
+  suppressHydrationWarning
+  style={{ ...OHW_LOADER_STYLE, display: 'none' }}
+>
+  <OhwLoaderSpinner />
+</div>
+{/* Inline script — shows the loader immediately on the client before React hydrates */}
+<script
+  dangerouslySetInnerHTML={{
+    __html: `(function(){try{
+      var p=location.hostname.split(".");
+      var fromHost=p.length>=3&&p[0]!=="www"?p[0]:"";
+      var fromQuery=new URLSearchParams(location.search).get("subdomain")||"";
+      if(!fromHost&&!fromQuery)return;
+      var e=document.getElementById("ohw-loader");
+      if(e)e.style.display="flex"
+    }catch(e){}})();`,
+  }}
+/>
+```
+The inline script detects whether the page is being loaded under a subdomain (personalised content mode) and shows the loader before React has a chance to hydrate, preventing a flash of the default content.
-Add `OhhwellsBridge` to your template's root layout:
+### 3. Mount `OhhwellsBridge`
+Add `<OhhwellsBridge />` inside a `<Suspense>` boundary in your root layout. It must be in `<Suspense>` because it calls `useSearchParams()` internally.
 ```tsx
+import { Suspense } from 'react'
 import { OhhwellsBridge } from '@ohhwells/bridge'
 export default function RootLayout({ children }) {
   return (
-    <html>
+    <html lang="en">
       <body>
+        {/* loader + inline script here (see step 2) */}
+        <Suspense>
+          <OhhwellsBridge />
+        </Suspense>
+        {/* rest of your layout */}
         {children}
-        <OhhwellsBridge />
       </body>
     </html>
   )
 }
 ```
-The bridge activates automatically when the page is loaded inside the OhhWells canvas editor. It has no effect in production (live site) mode.
+The bridge activates automatically when the page is loaded inside the OhhWells canvas editor. It does nothing in production (live site) mode.
-## Template attributes
+### 4. Mark sections
-Mark elements as editable using `data-ohw-*` attributes. See [VIBECODER.md](https://github.com/TheFlowOps-Eng/rebound-template/blob/main/VIBECODER.md) for the full authoring guide.
+Every top-level section on each page must have a unique `data-ohw-section` attribute. This is what the canvas editor uses to:
+- Show the "Add Section" insert line between sections
+- Persist widget insertions (saving which section a widget was inserted after)
-| Attribute | Value | Description |
-|---|---|---|
-| `data-ohw-key` | unique string | Identifier for storing/hydrating content |
-| `data-ohw-editable` | `text` \| `plain` \| `image` \| `bg-image` | Edit mode |
-| `data-ohw-editable-state` | `"hover,focus"` etc. | Declares available states on a container |
-| `data-ohw-state-view` | `"default"` \| `"success"` \| `"error"` \| `"hover"` | Wraps each state's content |
+```tsx
+// Good — section element is the direct content root
+<section data-ohw-section="hero">
+  ...
+</section>
+// Also fine — any element type works
+<div data-ohw-section="testimonials">
+  ...
+</div>
+```
-## Design tokens
+**Naming rules:**
+- Use `kebab-case`
+- Must be unique across the entire page
+- Must be stable — if a section is renamed, any saved widget insertions referencing that name will break
-The package ships with the full OhhWells design token set, scoped to `[data-ohw-bridge]` so styles never leak into the host template.
+**Example — a page with multiple sections:**
-### Semantic colors
+```tsx
+export default function HomePage() {
+  return (
+    <>
+      <section data-ohw-section="hero">...</section>
+      <section data-ohw-section="lagree-intro">...</section>
+      <section data-ohw-section="classes-strip">...</section>
+      <section data-ohw-section="testimonials">...</section>
+      <section data-ohw-section="plan-form">...</section>
+    </>
+  )
+}
+```
-All colors are defined as CSS variables on `[data-ohw-bridge-root]` and override-able per host:
+### 5. Mark editable elements
-| Token | Light | Dark |
-|---|---|---|
-| `background` | `#ffffff` | `#020617` |
-| `foreground` | `#020617` | `#f8fafc` |
-| `primary` | `#0f172a` | `#f8fafc` |
-| `primary-foreground` | `#f8fafc` | `#0f172a` |
-| `secondary` | `#f1f5f9` | `#1e293b` |
-| `muted` | `#f1f5f9` | `#1e293b` |
-| `muted-foreground` | `#64748b` | `#94a3b8` |
-| `accent` | `#f1f5f9` | `#1e293b` |
-| `border` | `#e2e8f0` | `#334155` |
-| `destructive` | `#dc2626` | `#7f1d1d` |
-| `success` | `#16a34a` | `#22c55e` |
+Add `data-ohw-editable` and `data-ohw-key` to any element the studio owner should be able to edit:
-### Typography
-Standard Tailwind scale with Figma-specified tracking:
-| Class | Size | Line height | Tracking |
-|---|---|---|---|
-| `text-9xl` | 128px | 1 | -0.025em |
-| `text-8xl` | 96px | 1 | -0.025em |
-| `text-7xl` | 72px | 1 | -0.025em |
-| `text-6xl` | 60px | 1 | -0.025em |
-| `text-5xl` | 48px | 1 | -0.025em |
-| `text-4xl` | 36px | 40px | -0.025em |
-| `text-3xl` | 30px | 36px | -0.025em |
-| `text-2xl` | 24px | 32px | -0.025em |
-| `text-xl` | 20px | 28px | -0.025em |
-| `text-lg` | 18px | 28px | 0 |
-| `text-base` | 16px | 24px | 0 |
-| `text-sm` | 14px | 20px | 0 |
-| `text-xs` | 12px | 16px | 0 |
+```tsx
+{/* Editable rich text (bold, italic, etc.) */}
+<h1
+  data-ohw-editable="text"
+  data-ohw-key="hero-heading"
+>
+  Welcome to the studio
+</h1>
+{/* Editable plain text (no formatting) */}
+<p
+  data-ohw-editable="plain"
+  data-ohw-key="hero-subtitle"
+>
+  Book your first class
+</p>
+{/* Editable image */}
+<img
+  data-ohw-editable="image"
+  data-ohw-key="hero-image"
+  src="/hero.jpg"
+  alt="Hero"
+/>
+{/* Editable background image */}
+<div
+  data-ohw-editable="bg-image"
+  data-ohw-key="hero-bg"
+  style={{ backgroundImage: 'url(/bg.jpg)' }}
+/>
+```
-### Brand palette
+**Key naming rules:**
+- Must be globally unique across all pages
+- Use `kebab-case`
+- Must be stable — changing a key orphans any saved content for that element
-Re:Bound brand colors are available as named tokens: `bone`, `ivory`, `sand`, `linen`, `stone`, `clay`, `umber`, `umber-deep`, `espresso`, `clove`, `ink`, `ash`, `carbon`.
+---
-## Dark mode
+## Editable states (advanced)
-Add the `dark` class to `[data-ohw-bridge-root]` to activate dark token overrides:
+For elements with multiple display states (e.g. a contact form with default/success/error views), wrap each state in a `data-ohw-state-view` and mark the container with `data-ohw-editable-state`:
-```html
-<div data-ohw-bridge-root class="dark">...</div>
+```tsx
+<div
+  data-ohw-editable-state="default,success,error"
+  data-ohw-key="contact-form"
+>
+  <div data-ohw-state-view="default">
+    {/* default form UI */}
+  </div>
+  <div data-ohw-state-view="success">
+    {/* success message */}
+  </div>
+  <div data-ohw-state-view="error">
+    {/* error message */}
+  </div>
+</div>
 ```
-## Development
+The bridge shows a state toggle in the canvas editor to switch between states.
-```bash
-# Install dependencies
-npm install
+---
+## Local development workflow
+When iterating on the bridge package itself:
-# Build (TypeScript + CSS)
+```bash
+# 1. Build the package
+cd ohhwells-bridge
 npm run build
-# Watch mode
-npm run dev
+# 2. Link it globally (one-time setup)
+npm link
+# 3. In your template repo, use the local build instead of the npm version
+cd rebound-template
+npm link @ohhwells/bridge
 ```
-Output is written to `dist/`:
-- `dist/index.js` — CJS
-- `dist/index.mjs` — ESM
-- `dist/index.d.ts` — TypeScript declarations
-- `dist/styles.css` — Scoped Tailwind CSS
+After that, every `npm run build` in `ohhwells-bridge` is picked up by the template immediately (no re-link needed). To go back to the npm version:
+```bash
+cd rebound-template
+npm unlink @ohhwells/bridge
+npm install
+```
+---
 ## Publishing
+The package publishes automatically via GitHub Actions on push to `main` (production tag) or `staging` (next tag). To publish manually:
 ```bash
 npm run build
 npm publish --access public
 ```
+---
+## Design tokens
+The package ships the full OhhWells design token set, scoped to `[data-ohw-bridge-root]` so styles never leak into the host template.
+### Semantic colors (CSS variables on `[data-ohw-bridge-root]`)
+| Token | Light | Dark |
+|---|---|---|
+| `primary` | `#0f172a` | `#f8fafc` |
+| `primary-foreground` | `#f8fafc` | `#0f172a` |
+| `background` | `#ffffff` | `#020617` |
+| `foreground` | `#020617` | `#f8fafc` |
+| `muted` | `#f1f5f9` | `#1e293b` |
+| `muted-foreground` | `#64748b` | `#94a3b8` |
+| `border` | `#e2e8f0` | `#334155` |
+| `destructive` | `#dc2626` | `#7f1d1d` |
+| `success` | `#16a34a` | `#22c55e` |
+### Brand palette
+Re:Bound brand colors: `bone`, `ivory`, `sand`, `linen`, `stone`, `clay`, `umber`, `umber-deep`, `espresso`, `clove`, `ink`, `ash`, `carbon`.
+---
 ## License
 MIT