Repository navigation
Expand file tree
/
Copy pathcontext7.json
More file actions
39 lines (39 loc) · 3.16 KB
/
Copy pathcontext7.json
File metadata and controls
39 lines (39 loc) · 3.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
"$schema": "https://context7.com/schema/context7.json",
"url": "https://context7.com/unlayer/elements",
"public_key": "pk_GRHFX0dq2BRyO29TL79nG",
"projectTitle": "Unlayer Elements",
"description": "React components for transactional emails, email templates, landing pages, invoices, reports and PDFs. Render email-safe HTML, responsive web HTML and print-ready PDF HTML from one component tree.",
"excludeFolders": [
".github",
"tests",
"packages/demo",
"packages/shared",
"node_modules",
"dist",
"coverage",
"storybook-static",
"output",
"packages/react/scripts",
".storybook"
],
"excludeFiles": [
"CHANGELOG.md",
"CONTRIBUTING.md",
"CLAUDE.md"
],
"rules": [
"Install @unlayer/react-elements. The root must be <Email>, <Page> or <Document> (use Document for print/PDF).",
"Structure is Root > Row > Column > content (Button, Paragraph, Heading, Image, Divider, Menu, Social, Html, Table, Video). Content components do not nest.",
"A Row's layout must match its number of Column children, e.g. ColumnLayouts.TwoEqual needs exactly 2 Columns.",
"renderToHtml() returns a complete HTML document; renderToJson() returns Unlayer design JSON that the Unlayer editor opens with loadDesign(). Both are synchronous.",
"There is no Text component: use Paragraph for body text and Heading for headings.",
"Start with packages/react/docs/README.md for task selection. Runnable transactional email, provider, PDF, and visual editing recipes are in packages/react/docs/ and examples/content-workflows/.",
"Elements renders HTML, not email delivery or PDF bytes. Send email HTML through a provider; print Document HTML with Playwright Chromium for a real PDF.",
"For shared templates, pass an Email/Page/Document root, or a component that returns one, to the renderers. Your own components and Fragments inside it can return Rows, Columns and blocks.",
"renderToHtml and renderToJson render the template once with React (hooks, Context and your own components work) and build the HTML and the design from the Rows, Columns and blocks it renders. A component that is async or suspends is left out: load data first. Raw HTML belongs in an Html block. Edited design JSON does not regenerate JSX; use editor.exportHtml for edited HTML.",
"To move React Email templates to Elements, run `npx @unlayer/migrate <folder> --report migration.md`, read the report, then add `--write`. It keeps props, loops and conditions, checks every template against the original, and lists what differs. After converting a template by hand, check it with `npx @unlayer/migrate compare <original> <migrated>`. See packages/react/docs/migrate-from-react-email.md.",
"To open React Email templates in the Unlayer editor, run `npx @unlayer/migrate <folder> --out <dir> --design` and pass each `<name>.design.json` to `loadDesign()`. See examples/react-email-in-editor.",
"To preview Elements code without installing, open https://examples.unlayer.com/examples/elements-playground/#code=<base64url of the code> (plain JSX, no imports; add &mode=email|page|document). In WebMCP browsers the page exposes a render_elements tool that returns the HTML."
]
}