@bygga.dev/editor 1.1.0 → 1.3.0

package/README.md

@@ -2,11 +2,14 @@
 
 `<bygga-editor>` — a visual builder for content **documents**, shipped as a native
 [custom element](https://developer.mozilla.org/en-US/docs/Web/API/Web_components).
-Email is the first document kind; landing pages are next. Built from Vue 3 and
+Two document kinds share one model: **email** (compiled to Outlook-safe sending HTML)
+and **page** (the same blocks compiled to a standalone web page). Built from Vue 3 and
 bundled with everything it needs, it embeds directly in any web page — no framework,
 no iframe — and renders into a shadow root, so host CSS can't leak in and editor
 styles can't leak out.
 
+The editor is built and maintained by [Memlist CRM](https://memlist.se)
+
 ## Install
 
 ```sh
@@ -103,6 +106,30 @@ per-locale labels (`{ firstName: { en: 'First name', sv: 'Förnamn' } }`). Popul
 the merge-tag picker; your backend must later resolve every id it sees. A missing
 locale label falls back to the default locale, then to the bare id.
 
+### `brand` property
+The colours and fonts your embed permits — a menu for the pickers, never a rewrite of a
+document. All halves are optional; an absent one is unrestricted.
+
+```js
+editor.brand = {
+  colors: ['#2f2a72', '#a28c67'],          // replaces the free spectrum with swatches
+  fonts: ['georgia', 'arial'],             // narrows the email-safe faces; first seeds new documents
+  customFonts: [                           // appends your own faces after the email-safe set
+    {
+      name: 'Acme Sans',                   // picker label; @font-face family for a font-file href
+      href: 'https://static.example.com/fonts/acme-sans.css', // stylesheet URL (e.g. a Google Fonts embed), or a .woff2/.ttf file
+      fontFamily: "'Acme Sans', Arial, sans-serif",           // optional exact stack to write
+    },
+  ],
+}
+```
+
+A custom face renders in the editor and wherever the compiled HTML is shown in a real
+browser engine (a view-online page, Apple Mail); most email clients strip remote fonts
+and fall back through the stack, so give `fontFamily` sensible fallbacks. The document
+carries what it uses (`customFonts` in its JSON), so it keeps rendering even if you later
+change the registration. Only http(s) hrefs register.
+
 ### `license-key` attribute
 Your licence key (see [You need a licence key](#you-need-a-licence-key)). Reactive: changing it
 re-activates, so a host that fetches its key can set it after the element is connected. Omit it on
@@ -140,7 +167,8 @@ Opaque by design: persist it (it's plain JSON — `JSON.stringify` it) and hand
 back, but don't reach into it, since the shape is the editor's to evolve. Two ways to
 get one:
 
-- **`createEmptyDocument()`** — a fresh blank document.
+- **`createEmptyDocument(kind?)`** — a fresh blank document; `'email'` (the default) or
+  `'page'` decides what it compiles to.
 - **`parseDocument(json)`** — the supported path from stored JSON back to a
   `Document`. Throws if the editor can't open it, so a corrupt row fails at your load
   boundary rather than deep inside the editor. Use what it returns, not what you
@@ -161,8 +189,8 @@ The package augments `HTMLElementTagNameMap`, so
 properties, methods, and a typed `addEventListener` for `change` / `dirtychange`
 included.
 
-- **Types:** `Document`, `EditorConfig`, `MergeTags`, `MergeTagLabels`, `Locale`,
-  `ByggaEditorElement`, `ByggaEditorEventMap`.
+- **Types:** `Document`, `EditorConfig`, `Brand`, `BrandFont`, `BrandCustomFont`,
+  `MergeTags`, `MergeTagLabels`, `Locale`, `ByggaEditorElement`, `ByggaEditorEventMap`.
 - **Values:** `createEmptyDocument`, `parseDocument`, `SUPPORTED_LOCALES`,
   `DEFAULT_LOCALE`, `EDITOR_TAG`, and `ByggaEditor` (the element constructor,
   already registered on import).