@charisol/plexo-sdk 2.0.8 → 2.0.9

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.
package/README.md CHANGED
@@ -260,6 +260,17 @@ The editor's own colours (not your visitors' page) follow three props. Pass any
260
260
  <V2Editor theme={{ accent: '#96F02E', background: '#000000', text: '#ffffff' }} />
261
261
  ```
262
262
 
263
+ ### Emails
264
+
265
+ The same editor designs emails: `<V2Editor mode="email" />`. In email mode only what every email app can draw is offered: text, buttons, pictures, dividers, spacing and rows of columns (which stack on a phone), in ready-made email sections (header, main message, text, highlights, call to action, picture, footer). There is no free placement, grid, shadow, animation or script, and Preview shows the email as it will arrive. Write the finished email with the compiler (tables with inline styles, plus a plain-text version):
266
+
267
+ ```ts
268
+ import { compilePageToEmail, emailIssues, starterEmailPages } from '@charisol/plexo-sdk/v2/compile';
269
+ const { html, text, warnings } = compilePageToEmail(page, { designSystem, preheader: 'Your account is ready' });
270
+ ```
271
+
272
+ Merge tags such as `{{first_name}}` pass through untouched for your sender to fill in.
273
+
263
274
  ### Where a form sends messages
264
275
 
265
276
  In order: the form's own address (the owner typed one) → the host's `formAction(formId)` → inside Plexo (`apiKey="workspace-internal"` plus `templateId`) Plexo's own form inbox → nothing, which the editor and the compiler both say plainly. A third-party app with a real Plexo key doesn't get Plexo's inbox (it finds the site from the page's own domain), so it passes `formAction`.