Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

feat: Add GitHub-style Alert component (#6279)

Oleg Isonene7181fffdcbc
diff --git a/apps/builder/app/builder/features/text-file-editor/markdown-preview.test.tsx b/apps/builder/app/builder/features/text-file-editor/markdown-preview.test.tsx
index 21b4826179..ef5ad75ba4 100644
--- a/apps/builder/app/builder/features/text-file-editor/markdown-preview.test.tsx
+++ b/apps/builder/app/builder/features/text-file-editor/markdown-preview.test.tsx
@@ -72,7 +72,7 @@ test("renders named MDX heading components with their authored tag", async () =>
origin: "https://builder.example",
});
- expect(html).toBe("<h1>h1</h1>\n");
+ expect(html).toBe("<h1>h1</h1>");
});
test("shows a placeholder for an empty component without a visible preview", async () => {
diff --git a/apps/builder/app/builder/features/text-file-editor/text-file-editor.test.tsx b/apps/builder/app/builder/features/text-file-editor/text-file-editor.test.tsx
index 59fd6d5154..d7dae91364 100644
--- a/apps/builder/app/builder/features/text-file-editor/text-file-editor.test.tsx
+++ b/apps/builder/app/builder/features/text-file-editor/text-file-editor.test.tsx
@@ -125,6 +125,7 @@ test("does not suggest registered custom components without templates", () => {
metas: componentMetas,
});
expect(completions.map(({ name }) => name).sort()).toEqual([
+ "Alert",
"CodeText",
"Image",
]);
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 0a31218aa4..6ea74067cc 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -61,6 +61,7 @@
* [📄 Paragraph](university/core-components/paragraph.md)
* [✏️ Inline Text](university/core-components/inline-text.md)
* [💬 Blockquote](university/core-components/blockquote.md)
+ * [⚠️ Alert](university/core-components/alert.md)
* [📄 Code Text](university/core-components/code-text.md)
* [✍️ Form](university/core-components/form.md)
* [✍️ Webhook Form](university/core-components/webhook-form.md)
diff --git a/docs/university/core-components/alert.md b/docs/university/core-components/alert.md
new file mode 100644
index 0000000000..aba0efcd99
--- /dev/null
+++ b/docs/university/core-components/alert.md
@@ -0,0 +1,28 @@
+---
+description: Highlight notes, tips, warnings, and other important information with the Alert component.
+---
+
+# Alert
+
+Use Alert for information that deserves extra attention without interrupting the main content.
+
+## How to use Alert
+
+Add Alert from **Components > Text**, then edit its paragraph or add other content inside it.
+
+Choose **Variant** under **Properties & attributes** to set the alert to **Note**, **Tip**, **Important**, **Warning**, or **Caution**.
+
+## Styling
+
+Style the Alert instance for its container appearance. The selected variant produces the corresponding component state, so you can style **Note**, **Tip**, **Important**, **Warning**, and **Caution** independently in the states menu.
+
+Alerts created from GitHub-style syntax in a Content Block `.mdx` file become Alert component instances. Changing the instance's **Variant** property updates the alert marker when Webstudio saves the MDX source.
+
+Markdown Embed supports the same variants and rendered `data-state` values.
+
+## Related
+
+- [Markdown Embed](markdown-embed.md) – Render GitHub-style alerts from Markdown
+- [Content Block](content-block.md) – Edit MDX as component instances
+- [Blockquote](blockquote.md) – Display quoted content
+- [Paragraph](paragraph.md) – Add body text
diff --git a/docs/university/core-components/content-block.md b/docs/university/core-components/content-block.md
index 3a1a19dae5..d973fa9bd9 100644
--- a/docs/university/core-components/content-block.md
+++ b/docs/university/core-components/content-block.md
@@ -166,6 +166,18 @@ Regular document content stays Markdown and uses the matching standard templates
The JSX name matches the stable **Name** of a unique top-level template in the Content Block's Templates list. **Name** is a JavaScript identifier and is separate from the optional **Label** shown in the canvas. If no template has that name, the custom component is unresolved and is not rendered. Its JSX remains in the file so adding the matching template can resolve it later. A new template gets its default name from its root component or HTML tag, and duplicate defaults get deterministic numeric suffixes.
+Use GitHub-style alert syntax for notes, tips, important information, warnings, and cautions:
+
+```mdx
+> [!NOTE]
+> Add helpful context here.
+
+> [!WARNING]
+> Explain what readers should be careful about.
+```
+
+Write `NOTE`, `TIP`, `IMPORTANT`, `WARNING`, or `CAUTION` in uppercase at the start of a blockquote. Each alert becomes an [Alert component](alert.md) in the Content Block. When Webstudio writes the file after a canvas edit, it uses the equivalent `<Alert variant="...">` JSX.
+
In the MDX editor, type `<` to autocomplete templates connected to the file and built-in Image and CodeText components. Inside a JSX tag, autocomplete suggests its supported properties and available property values.
Missing template references are marked as errors at their JSX source range. Hover the underline to read the explanation. For dynamic sources, the editor also uses currently rendered Content Blocks to find the file's templates.
@@ -337,5 +349,6 @@ Beyond adding new content, you can edit the existing content inside the Content
- [Content Engine](../foundations/content-engine.md) – Build file-based sites with visually editable MDX articles
- [Slot](slot.md) – Reusable component slots
+- [Alert](alert.md) – Highlight notes, warnings, and other callouts
- [Modes](../foundations/modes.md) – Builder modes including Content mode
- [Collection](collection.md) – Iterate over dynamic data
diff --git a/docs/university/core-components/markdown-embed.md b/docs/university/core-components/markdown-embed.md
index 33a721be7c..28f7f581c5 100644
--- a/docs/university/core-components/markdown-embed.md
+++ b/docs/university/core-components/markdown-embed.md
@@ -32,6 +32,22 @@ In the Navigator, Markdown Embed has various HTML tags nested. Expand Markdown E
Styles applied to each of these tags will apply to all occurrences of that tag within the Markdown Embed. For example, if you apply a border on the Image tag, then all images contained within the HTML will have a border.
+## GitHub-style alerts
+
+Use GitHub-style alerts to call attention to notes, tips, important information, warnings, and cautions:
+
+```markdown
+> [!NOTE]
+> Add helpful context here.
+
+> [!WARNING]
+> Explain what readers should be careful about.
+```
+
+Write the alert type in uppercase at the start of a blockquote. Markdown Embed supports `NOTE`, `TIP`, `IMPORTANT`, `WARNING`, and `CAUTION`. You can use links, lists, code, and other Markdown inside an alert.
+
+Select **Alert** to style every alert, or a type-specific descendant such as **Warning alert** to style one alert type. Markdown Embed renders the same `data-state` values as the standalone [Alert component](alert.md).
+
## Image handling
Webstudio optimizes images contained in Markdown with the same responsive image pipeline as the [Image component](image.md#optimize). It generates the appropriate `srcset` and `sizes` attributes and lazy-loads images by default.
@@ -51,5 +67,6 @@ Data URL images are served as-is without optimization.
## Related
- [Content Embed](content-embed.md) – Render rich text/HTML
+- [Alert](alert.md) – Add and style standalone callouts
- [HTML Embed](html-embed.md) – Custom HTML code
- [Collection](collection.md) – Loop through CMS data
diff --git a/packages/content-engine/package.json b/packages/content-engine/package.json
index 1be08dda2f..1ceca28491 100644
--- a/packages/content-engine/package.json
+++ b/packages/content-engine/package.json
@@ -10,7 +10,7 @@
"scripts": {
"benchmark:index": "NODE_OPTIONS=--conditions=webstudio pnpm tsx scripts/benchmark-index.mjs",
"benchmark:scale": "NODE_OPTIONS=--conditions=webstudio pnpm tsx scripts/benchmark-scale.mjs",
- "build": "rm -rf lib && esbuild src/index.ts src/asset-content-repository.ts src/asset-content-session.ts src/compiler.ts src/jsx-attributes.ts src/limits.ts src/markdown-assets.ts src/markdown-references.ts src/mdx.ts src/published-runtime.ts --outdir=lib --bundle --format=esm --packages=external",
+ "build": "rm -rf lib && esbuild src/index.ts src/asset-content-repository.ts src/asset-content-session.ts src/compiler.ts src/jsx-attributes.ts src/limits.ts src/markdown-assets.ts src/markdown-references.ts src/mdx.ts src/published-runtime.ts src/remark-github-alerts.ts --outdir=lib --bundle --format=esm --packages=external",
"dts": "tsc --project tsconfig.dts.json",
"test": "vitest run",
"typecheck": "tsc --noEmit"
@@ -98,6 +98,12 @@
"import": "./lib/markdown-assets.js",
"default": "./src/markdown-assets.ts"
},
+ "./remark-github-alerts": {
+ "webstudio": "./src/remark-github-alerts.ts",
+ "types": "./lib/types/remark-github-alerts.d.ts",
+ "import": "./lib/remark-github-alerts.js",
+ "default": "./src/remark-github-alerts.ts"
+ },
"./markdown-references": {
"webstudio": "./src/markdown-references.ts",
"types": "./lib/types/markdown-references.d.ts",
diff --git a/packages/content-engine/src/markdown-ast.ts b/packages/content-engine/src/markdown-ast.ts
index cffa77a0cf..2fa422c5d9 100644
--- a/packages/content-engine/src/markdown-ast.ts
+++ b/packages/content-engine/src/markdown-ast.ts
@@ -3,6 +3,7 @@ import remarkGfm from "remark-gfm";
import remarkMdx, { type Options as RemarkMdxOptions } from "remark-mdx";
import remarkParse from "remark-parse";
import { unified } from "unified";
+import { remarkGithubAlerts } from "./remark-github-alerts";
export type SyntaxTreeNode = {
type: string;
@@ -26,7 +27,11 @@ export const getSyntaxTreeChildren = (node: SyntaxTreeNode) => {
};
const createMarkdownAstParser = () =>
- unified().use(remarkParse).use(remarkFrontmatter, ["yaml"]).use(remarkGfm);
+ unified()
+ .use(remarkParse)
+ .use(remarkFrontmatter, ["yaml"])
+ .use(remarkGfm)
+ .use(remarkGithubAlerts);
const markdownAstParser = createMarkdownAstParser();
// Match standalone Webstudio JSX. remark-mdx 2 exposes obsolete types but
@@ -46,7 +51,7 @@ const mdxAstParser = createMarkdownAstParser().use(remarkMdx, mdxOptions);
export const parseMarkdownAst = (
source: string,
syntax: "markdown" | "mdx" = "markdown"
-): SyntaxTreeNode =>
- (syntax === "mdx" ? mdxAstParser : markdownAstParser).parse(
- source
- ) as SyntaxTreeNode;
+): SyntaxTreeNode => {
+ const parser = syntax === "mdx" ? mdxAstParser : markdownAstParser;
+ return parser.runSync(parser.parse(source)) as SyntaxTreeNode;
+};
diff --git a/packages/content-engine/src/mdx.test.ts b/packages/content-engine/src/mdx.test.ts
index 0ff4794cff..9f99f22846 100644
--- a/packages/content-engine/src/mdx.test.ts
+++ b/packages/content-engine/src/mdx.test.ts
@@ -175,6 +175,54 @@ const forceGenericMdx = (node: MdxAuthoredNode): MdxAuthoredNode => {
};
describe("parseMdxDocument", () => {
+ test.each(["NOTE", "TIP", "IMPORTANT", "WARNING", "CAUTION"] as const)(
+ "maps GitHub %s alerts to Alert templates",
+ async (type) => {
+ const document = await parseMdxDocument({
+ source: `> [!${type}]\n> Alert with **strong** text.\n`,
+ });
+
+ expect(omitSourceRanges(document.children)).toEqual([
+ {
+ type: "template",
+ syntax: "jsx",
+ selfClosing: false,
+ name: "Alert",
+ props: [{ name: "variant", value: type.toLowerCase() }],
+ mdxMode: "flow",
+ children: [
+ {
+ type: "element",
+ syntax: "markdown",
+ tag: "p",
+ props: [],
+ children: [
+ { type: "text", value: "Alert with " },
+ {
+ type: "element",
+ syntax: "markdown",
+ tag: "strong",
+ props: [],
+ children: [{ type: "text", value: "strong" }],
+ },
+ { type: "text", value: " text." },
+ ],
+ },
+ ],
+ },
+ ]);
+ }
+ );
+
+ test("serializes GitHub alerts as standard Alert templates", async () => {
+ const source = `> [!WARNING]\n> First paragraph.\n>\n> - One\n> - Two\n`;
+ const document = await parseMdxDocument({ source });
+
+ expect(serializeMdxDocument(document)).toBe(
+ '<Alert variant="warning">\n First paragraph.\n\n - One\n - Two\n</Alert>\n'
+ );
+ });
+
test("parses and preserves safe named JSX template references", async () => {
const source = `<Card tone="quiet">\n ## Nested heading\n</Card>\n`;
const document = await parseMdxDocument({ source });
diff --git a/packages/content-engine/src/mdx.ts b/packages/content-engine/src/mdx.ts
index 8138a42452..96201d28a2 100644
--- a/packages/content-engine/src/mdx.ts
+++ b/packages/content-engine/src/mdx.ts
@@ -44,6 +44,10 @@ import {
serializeMdxDocument,
} from "./mdx-serialization";
import { MarkdownMetadataError } from "./markdown-errors";
+import {
+ getGithubAlertType,
+ githubAlertHastHandler,
+} from "./remark-github-alerts";
export type MdxSourcePoint = Readonly<{
line: number;
@@ -841,6 +845,7 @@ const rejectUnsupportedNode: Handler = (_state, value) => {
};
const mdxHandlers: Handlers = {
+ blockquote: githubAlertHastHandler,
code: preserveWhitespace(defaultHandlers.code),
html: rejectUnsupportedNode,
inlineCode: preserveWhitespace(defaultHandlers.inlineCode),
@@ -934,6 +939,7 @@ const createMarkdownHastForMdx = (root: SyntaxTreeNode) => {
const hast = toHast(root as Parameters<typeof toHast>[0], {
allowDangerousHtml: true,
handlers: {
+ blockquote: githubAlertHastHandler,
code: mdxHandlers.code,
inlineCode: mdxHandlers.inlineCode,
listItem: mdxHandlers.listItem,
@@ -1206,6 +1212,7 @@ const mapHastNode = (
);
}
const authoredMdxMode = findHastMdxMode(node);
+ const githubAlert = getGithubAlertType(node);
const templateName = findHastTemplateName(node);
const templateProps =
templateName === undefined ? undefined : findHastTemplateProps(node);
@@ -1241,6 +1248,18 @@ const mapHastNode = (
sourceRange: toSourceRange(node.position),
};
}
+ if (githubAlert !== undefined) {
+ return {
+ type: "template",
+ syntax: "jsx",
+ selfClosing: false,
+ name: "Alert",
+ props: [{ name: "variant", value: githubAlert.toLowerCase() }],
+ children: mapHastChildren(node, options),
+ mdxMode: "flow",
+ sourceRange: toSourceRange(node.position),
+ };
+ }
if (
authoredMdxMode !== undefined &&
unsupportedElementTags.has(node.tagName.toLowerCase())
diff --git a/packages/content-engine/src/remark-github-alerts.ts b/packages/content-engine/src/remark-github-alerts.ts
new file mode 100644
index 0000000000..7e5fac5b1f
--- /dev/null
+++ b/packages/content-engine/src/remark-github-alerts.ts
@@ -0,0 +1,91 @@
+import { defaultHandlers, type Handler } from "mdast-util-to-hast";
+
+type MarkdownNode = {
+ type: string;
+ value?: unknown;
+ children?: MarkdownNode[];
+ data?: Record<string, unknown>;
+};
+
+export const githubAlertTypes = [
+ "NOTE",
+ "TIP",
+ "IMPORTANT",
+ "WARNING",
+ "CAUTION",
+] as const;
+
+export type GithubAlertType = (typeof githubAlertTypes)[number];
+
+export const getGithubAlertType = (node: unknown) => {
+ if (typeof node !== "object" || node === null || !("data" in node)) {
+ return;
+ }
+ const data = node.data;
+ if (typeof data !== "object" || data === null || !("githubAlert" in data)) {
+ return;
+ }
+ const type = data.githubAlert;
+ return githubAlertTypes.find((candidate) => candidate === type);
+};
+
+const getMarker = (value: string) => {
+ for (const type of githubAlertTypes) {
+ const marker = `[!${type}]`;
+ if (value === marker) {
+ return { type, length: marker.length };
+ }
+ if (value.startsWith(`${marker}\n`)) {
+ return { type, length: marker.length + 1 };
+ }
+ if (value.startsWith(`${marker}\r\n`)) {
+ return { type, length: marker.length + 2 };
+ }
+ }
+};
+
+export const transformGithubAlerts = (tree: unknown) => {
+ const visit = (node: MarkdownNode) => {
+ for (const child of node.children ?? []) {
+ visit(child);
+ }
+ if (node.type !== "blockquote") {
+ return;
+ }
+ const paragraph = node.children?.[0];
+ const markerNode = paragraph?.children?.[0];
+ if (
+ paragraph?.type !== "paragraph" ||
+ markerNode?.type !== "text" ||
+ typeof markerNode.value !== "string"
+ ) {
+ return;
+ }
+ const marker = getMarker(markerNode.value);
+ if (marker === undefined) {
+ return;
+ }
+ markerNode.value = markerNode.value.slice(marker.length);
+ if (markerNode.value === "") {
+ paragraph.children?.shift();
+ }
+ if (paragraph.children?.length === 0) {
+ node.children?.shift();
+ }
+ node.data = { ...node.data, githubAlert: marker.type };
+ };
+ if (typeof tree === "object" && tree !== null && "type" in tree) {
+ visit(tree as MarkdownNode);
+ }
+};
+
+export const remarkGithubAlerts = () => transformGithubAlerts;
+
+export const githubAlertHastHandler: Handler = (state, node) => {
+ const result = defaultHandlers.blockquote(state, node);
+ const type = getGithubAlertType(node);
+ if (type !== undefined) {
+ result.data = { ...result.data, githubAlert: type };
+ }
+ return result;
+};
diff --git a/packages/project-build/src/runtime/component-templates.test.ts b/packages/project-build/src/runtime/component-templates.test.ts
index e9c8edcba7..9fc25baeb4 100644
--- a/packages/project-build/src/runtime/component-templates.test.ts
+++ b/packages/project-build/src/runtime/component-templates.test.ts
@@ -6,6 +6,14 @@ describe("getComponentTemplates", () => {
const templates = getComponentTemplates();
expect(getComponentTemplates()).toBe(templates);
+ expect(templates.get("Alert")).toEqual(
+ expect.objectContaining({
+ template: expect.objectContaining({
+ children: expect.any(Array),
+ instances: expect.any(Array),
+ }),
+ })
+ );
expect(templates.get("Form")).toEqual(
expect.objectContaining({
template: expect.objectContaining({
diff --git a/packages/project-build/src/runtime/mdx-template-resolution.test.ts b/packages/project-build/src/runtime/mdx-template-resolution.test.ts
index 3615b3787d..5b27d64c05 100644
--- a/packages/project-build/src/runtime/mdx-template-resolution.test.ts
+++ b/packages/project-build/src/runtime/mdx-template-resolution.test.ts
@@ -48,6 +48,9 @@ Next line.
> Blockquote
+> [!NOTE]
+> Alert
+
- [x] Task item
- List item
diff --git a/packages/sdk-components-react/package.json b/packages/sdk-components-react/package.json
index d37d637cda..520eb169d5 100644
--- a/packages/sdk-components-react/package.json
+++ b/packages/sdk-components-react/package.json
@@ -80,6 +80,7 @@
"@react-aria/utils": "^3.27.0",
"@shikijs/langs": "4.4.1",
"@shikijs/themes": "4.4.1",
+ "@webstudio-is/content-engine": "workspace:*",
"@webstudio-is/icons": "workspace:*",
"@webstudio-is/image": "workspace:*",
"@webstudio-is/react-sdk": "workspace:*",
@@ -88,11 +89,13 @@
"colord": "^2.9.3",
"decode-named-character-reference": "1.0.2",
"github-slugger": "2.0.0",
+ "hast-util-to-html": "9.0.5",
"hast-util-to-jsx-runtime": "^2.3.6",
"mdast-util-from-markdown": "2.0.3",
"mdast-util-frontmatter": "2.0.1",
+ "mdast-util-gfm": "3.1.0",
+ "mdast-util-to-hast": "13.2.1",
"mdast-util-to-string": "4.0.0",
- "micromark": "^4.0.2",
"micromark-extension-frontmatter": "2.0.0",
"micromark-extension-gfm": "^3.0.0",
"sanitize-html": "2.17.5",
@@ -110,7 +113,6 @@
"@webstudio-is/sdk-cli": "workspace:*",
"@webstudio-is/template": "workspace:*",
"@webstudio-is/tsconfig": "workspace:*",
- "micromark-util-types": "2.0.2",
"nanostores": "^0.11.3",
"playwright": "1.50.1",
"react": "18.3.0-canary-14898b6a9-20240318",
diff --git a/packages/sdk-components-react/src/__generated__/alert.props.ts b/packages/sdk-components-react/src/__generated__/alert.props.ts
new file mode 100644
index 0000000000..7877704753
--- /dev/null
+++ b/packages/sdk-components-react/src/__generated__/alert.props.ts
@@ -0,0 +1,11 @@
+import type { PropMeta } from "@webstudio-is/sdk";
+
+export const props: Record<string, PropMeta> = {
+ variant: {
+ required: false,
+ control: "select",
+ type: "string",
+ defaultValue: "note",
+ options: ["note", "tip", "important", "warning", "caution"],
+ },
+};
diff --git a/packages/sdk-components-react/src/__generated__/alert.stories.tsx b/packages/sdk-components-react/src/__generated__/alert.stories.tsx
new file mode 100644
index 0000000000..cd5408e902
--- /dev/null
+++ b/packages/sdk-components-react/src/__generated__/alert.stories.tsx
@@ -0,0 +1,69 @@
+import {
+ Box as Box,
+ Alert as Alert,
+ Paragraph as Paragraph,
+} from "../components";
+
+const Component = () => {
+ return (
+ <Box className={`w-box`}>
+ <Alert variant={"note"} className={`w-alert`}>
+ <Paragraph className={`w-paragraph`}>
+ {"Add helpful context here."}
+ </Paragraph>
+ </Alert>
+ </Box>
+ );
+};
+
+export default {
+ title: "Components/Alert",
+};
+
+const Story = {
+ render() {
+ return (
+ <>
+ <style>
+ {`
+@layer presets {
+ div.w-alert {
+ box-sizing: border-box;
+ border-top-left-radius: 8px;
+ border-top-right-radius: 8px;
+ border-bottom-right-radius: 8px;
+ border-bottom-left-radius: 8px;
+ padding: 16px
+ }
+ div.w-alert[data-state="caution"] {
+ background-color: rgb(254 226 226 / 1)
+ }
+ div.w-alert[data-state="important"] {
+ background-color: rgb(238 242 255 / 1)
+ }
+ div.w-alert[data-state="note"] {
+ background-color: rgb(239 246 255 / 1)
+ }
+ div.w-alert[data-state="tip"] {
+ background-color: rgb(236 253 245 / 1)
+ }
+ div.w-alert[data-state="warning"] {
+ background-color: rgb(254 243 199 / 1)
+ }
+ div.w-box {
+ box-sizing: border-box
+ }
+ p.w-paragraph {
+ box-sizing: border-box
+ }
+}
+
+ `}
+ </style>
+ <Component />
+ </>
+ );
+ },
+};
+
+export { Story as Alert };
diff --git a/packages/sdk-components-react/src/__generated__/markdown-embed.stories.tsx b/packages/sdk-components-react/src/__generated__/markdown-embed.stories.tsx
index 2c4cb8a2f7..292b991b75 100644
--- a/packages/sdk-components-react/src/__generated__/markdown-embed.stories.tsx
+++ b/packages/sdk-components-react/src/__generated__/markdown-embed.stories.tsx
@@ -5,9 +5,9 @@ const Component = () => {
<Box className={`w-box`}>
<MarkdownEmbed
code={
- '# Styling Markdown with Markdown Embed\n\nMarkdown Embed allows styling of Markdown, which primarily comes from external data.\n\n## How to Use Markdown Embed\n\n- Every element is shown in the Navigator.\n- Apply styles and Tokens to each element.\n- Adjustments to elements apply universally within this embed, ensuring consistency across your content.\n\n---\n\n## This sample text contains all the elements that can be styled.\n\nAny elements that were not used above are used below.\n\n### Heading 3\n#### Heading 4\n##### Heading 5\n###### Heading 6\n\n[Links](#) connect your content to relevant resources.\n\n**Bold text** makes your important points stand out.\n\n*Italic text* is great for emphasizing terms.\n\n1. First Step\n2. Second Step\n\n![Image placeholder](data:image/svg+xml;base64,PHN2ZwogIHdpZHRoPSIxNDAiCiAgaGVpZ2h0PSIxNDAiCiAgdmlld0JveD0iMCAwIDYwMCA2MDAiCiAgZmlsbD0ibm9uZSIKICB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgPgogIDxyZWN0IHdpZHRoPSI2MDAiIGhlaWdodD0iNjAwIiBmaWxsPSIjREZFM0U2IiAvPgogIDxwYXRoCiAgICBmaWxsLXJ1bGU9ImV2ZW5vZGQiCiAgICBjbGlwLXJ1bGU9ImV2ZW5vZGQiCiAgICBkPSJNNDUwIDE3MEgxNTBDMTQxLjcxNiAxNzAgMTM1IDE3Ni43MTYgMTM1IDE4NVY0MTVDMTM1IDQyMy4yODQgMTQxLjcxNiA0MzAgMTUwIDQzMEg0NTBDNDU4LjI4NCA0MzAgNDY1IDQyMy4yODQgNDY1IDQxNVYxODVDNDY1IDE3Ni43MTYgNDU4LjI4NCAxNzAgNDUwIDE3MFpNMTUwIDE0NUMxMjcuOTA5IDE0NSAxMTAgMTYyLjkwOSAxMTAgMTg1VjQxNUMxMTAgNDM3LjA5MSAxMjcuOTA5IDQ1NSAxNTAgNDU1SDQ1MEM0NzIuMDkxIDQ1NSA0OTAgNDM3LjA5MSA0OTAgNDE1VjE4NUM0OTAgMTYyLjkwOSA0NzIuMDkxIDE0NSA0NTAgMTQ1SDE1MFoiCiAgICBmaWxsPSIjQzFDOENEIgogIC8+CiAgPHBhdGgKICAgIGQ9Ik0yMzcuMTM1IDIzNS4wMTJDMjM3LjEzNSAyNTUuNzIzIDIyMC4zNDUgMjcyLjUxMiAxOTkuNjM1IDI3Mi41MTJDMTc4LjkyNCAyNzIuNTEyIDE2Mi4xMzUgMjU1LjcyMyAxNjIuMTM1IDIzNS4wMTJDMTYyLjEzNSAyMTQuMzAxIDE3OC45MjQgMTk3LjUxMiAxOTkuNjM1IDE5Ny41MTJDMjIwLjM0NSAxOTcuNTEyIDIzNy4xMzUgMjE0LjMwMSAyMzcuMTM1IDIzNS4wMTJaIgogICAgZmlsbD0iI0MxQzhDRCIKICAvPgogIDxwYXRoCiAgICBkPSJNMTYwIDQwNVYzNjcuMjA1TDIyMS42MDkgMzA2LjM2NEwyNTYuNTUyIDMzOC42MjhMMzU4LjE2MSAyMzRMNDQwIDMxNi4wNDNWNDA1SDE2MFoiCiAgICBmaWxsPSIjQzFDOENEIgogIC8+Cjwvc3ZnPg==)\n\n> Capture attention with a powerful quote.\n\nUsing `console.log("Hello World");` will log to the console.\n\n| Header 1 | Header 2 | Header 3 |\n|------------|------------|------------|\n| Cell 1.1 | Cell 1.2 | Cell 1.3 |\n| Cell 2.1 | Cell 2.2 | Cell 2.3 |\n| Cell 3.1 | Cell 3.2 | Cell 3.3 |'
+ '# Styling Markdown with Markdown Embed\n\nMarkdown Embed allows styling of Markdown, which primarily comes from external data.\n\n## How to Use Markdown Embed\n\n- Every element is shown in the Navigator.\n- Apply styles and Tokens to each element.\n- Adjustments to elements apply universally within this embed, ensuring consistency across your content.\n\n---\n\n## This sample text contains all the elements that can be styled.\n\nAny elements that were not used above are used below.\n\n### Heading 3\n#### Heading 4\n##### Heading 5\n###### Heading 6\n\n[Links](#) connect your content to relevant resources.\n\n**Bold text** makes your important points stand out.\n\n*Italic text* is great for emphasizing terms.\n\n1. First Step\n2. Second Step\n\n![Image placeholder](data:image/svg+xml;base64,PHN2ZwogIHdpZHRoPSIxNDAiCiAgaGVpZ2h0PSIxNDAiCiAgdmlld0JveD0iMCAwIDYwMCA2MDAiCiAgZmlsbD0ibm9uZSIKICB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgPgogIDxyZWN0IHdpZHRoPSI2MDAiIGhlaWdodD0iNjAwIiBmaWxsPSIjREZFM0U2IiAvPgogIDxwYXRoCiAgICBmaWxsLXJ1bGU9ImV2ZW5vZGQiCiAgICBjbGlwLXJ1bGU9ImV2ZW5vZGQiCiAgICBkPSJNNDUwIDE3MEgxNTBDMTQxLjcxNiAxNzAgMTM1IDE3Ni43MTYgMTM1IDE4NVY0MTVDMTM1IDQyMy4yODQgMTQxLjcxNiA0MzAgMTUwIDQzMEg0NTBDNDU4LjI4NCA0MzAgNDY1IDQyMy4yODQgNDY1IDQxNVYxODVDNDY1IDE3Ni43MTYgNDU4LjI4NCAxNzAgNDUwIDE3MFpNMTUwIDE0NUMxMjcuOTA5IDE0NSAxMTAgMTYyLjkwOSAxMTAgMTg1VjQxNUMxMTAgNDM3LjA5MSAxMjcuOTA5IDQ1NSAxNTAgNDU1SDQ1MEM0NzIuMDkxIDQ1NSA0OTAgNDM3LjA5MSA0OTAgNDE1VjE4NUM0OTAgMTYyLjkwOSA0NzIuMDkxIDE0NSA0NTAgMTQ1SDE1MFoiCiAgICBmaWxsPSIjQzFDOENEIgogIC8+CiAgPHBhdGgKICAgIGQ9Ik0yMzcuMTM1IDIzNS4wMTJDMjM3LjEzNSAyNTUuNzIzIDIyMC4zNDUgMjcyLjUxMiAxOTkuNjM1IDI3Mi41MTJDMTc4LjkyNCAyNzIuNTEyIDE2Mi4xMzUgMjU1LjcyMyAxNjIuMTM1IDIzNS4wMTJDMTYyLjEzNSAyMTQuMzAxIDE3OC45MjQgMTk3LjUxMiAxOTkuNjM1IDE5Ny41MTJDMjIwLjM0NSAxOTcuNTEyIDIzNy4xMzUgMjE0LjMwMSAyMzcuMTM1IDIzNS4wMTJaIgogICAgZmlsbD0iI0MxQzhDRCIKICAvPgogIDxwYXRoCiAgICBkPSJNMTYwIDQwNVYzNjcuMjA1TDIyMS42MDkgMzA2LjM2NEwyNTYuNTUyIDMzOC42MjhMMzU4LjE2MSAyMzRMNDQwIDMxNi4wNDNWNDA1SDE2MFoiCiAgICBmaWxsPSIjQzFDOENEIgogIC8+Cjwvc3ZnPg==)\n\n> Capture attention with a powerful quote.\n\n> [!NOTE]\n> Add helpful context without interrupting the main content.\n\n> [!TIP]\n> Share a useful suggestion.\n\n> [!IMPORTANT]\n> Highlight essential information.\n\n> [!WARNING]\n> Point out something readers should be careful about.\n\n> [!CAUTION]\n> Explain a potential negative consequence.\n\nUsing `console.log("Hello World");` will log to the console.\n\n| Header 1 | Header 2 | Header 3 |\n|------------|------------|------------|\n| Cell 1.1 | Cell 1.2 | Cell 1.3 |\n| Cell 2.1 | Cell 2.2 | Cell 2.3 |\n| Cell 3.1 | Cell 3.2 | Cell 3.3 |'
}
- className={`w-markdown-embed`}
+ className={`w-markdown-embed w-alert`}
></MarkdownEmbed>
</Box>
);
@@ -33,7 +33,30 @@ const Story = {
white-space-collapse: collapse
}
}
-
+@media all {
+ .w-alert [data-state] {
+ border-top-left-radius: 8px;
+ border-top-right-radius: 8px;
+ border-bottom-right-radius: 8px;
+ border-bottom-left-radius: 8px;
+ padding: 16px
+ }
+ .w-alert [data-state][data-state="caution"] {
+ background-color: #fee2e2
+ }
+ .w-alert [data-state][data-state="important"] {
+ background-color: #eef2ff
+ }
+ .w-alert [data-state][data-state="note"] {
+ background-color: #eff6ff
+ }
+ .w-alert [data-state][data-state="tip"] {
+ background-color: #ecfdf5
+ }
+ .w-alert [data-state][data-state="warning"] {
+ background-color: #fef3c7
+ }
+}
`}
</style>
<Component />
diff --git a/packages/sdk-components-react/src/alert-template.test.ts b/packages/sdk-components-react/src/alert-template.test.ts
new file mode 100644
index 0000000000..12474ff138
--- /dev/null
+++ b/packages/sdk-components-react/src/alert-template.test.ts
@@ -0,0 +1,27 @@
+import {
+ renderTemplate,
+ type TemplateComponent,
+ type TemplateMeta,
+} from "@webstudio-is/template";
+import { expect, test } from "vitest";
+import { MarkdownEmbed as MarkdownEmbedComponent } from "./components";
+import { meta as MarkdownEmbed } from "./markdown-embed.template";
+
+const componentIds = new Map<TemplateComponent, string>([
+ [MarkdownEmbedComponent, "MarkdownEmbed"],
+]);
+
+const getVariantBackgroundStates = ({ template }: TemplateMeta) =>
+ renderTemplate(template, undefined, [], { componentIds })
+ .styles.filter(({ property }) => property === "backgroundColor")
+ .map(({ state }) => state);
+
+test("provides light backgrounds for every Markdown Embed alert variant", () => {
+ expect(getVariantBackgroundStates(MarkdownEmbed)).toEqual([
+ '[data-state="note"]',
+ '[data-state="tip"]',
+ '[data-state="important"]',
+ '[data-state="warning"]',
+ '[data-state="caution"]',
+ ]);
+});
diff --git a/packages/sdk-components-react/src/alert.test.tsx b/packages/sdk-components-react/src/alert.test.tsx
new file mode 100644
index 0000000000..04631c26e3
--- /dev/null
+++ b/packages/sdk-components-react/src/alert.test.tsx
@@ -0,0 +1,50 @@
+import { renderToStaticMarkup } from "react-dom/server";
+import { describe, expect, test } from "vitest";
+import { Alert } from "./alert";
+import { meta } from "./alert.ws";
+
+describe("Alert", () => {
+ test("is stylable in the Builder", () => {
+ expect(meta.presetStyle).toBeDefined();
+ });
+
+ test("provides a light background for every variant", () => {
+ expect(
+ meta.presetStyle?.div
+ ?.filter(({ property }) => property === "background-color")
+ .map(({ state }) => state)
+ ).toEqual([
+ '[data-state="note"]',
+ '[data-state="tip"]',
+ '[data-state="important"]',
+ '[data-state="warning"]',
+ '[data-state="caution"]',
+ ]);
+ });
+
+ test("exposes variants as property-driven style states", () => {
+ expect(meta.initialProps).toContain("variant");
+ expect(meta.states).toEqual([
+ { label: "Note", selector: '[data-state="note"]' },
+ { label: "Tip", selector: '[data-state="tip"]' },
+ { label: "Important", selector: '[data-state="important"]' },
+ { label: "Warning", selector: '[data-state="warning"]' },
+ { label: "Caution", selector: '[data-state="caution"]' },
+ ]);
+ });
+
+ test.each(["note", "tip", "important", "warning", "caution"] as const)(
+ "renders the %s variant as component state",
+ (variant) => {
+ const html = renderToStaticMarkup(
+ <Alert variant={variant} className="custom">
+ <p>Content</p>
+ </Alert>
+ );
+
+ expect(html).toBe(
+ `<div class="custom" role="note" data-state="${variant}"><p>Content</p></div>`
+ );
+ }
+ );
+});
diff --git a/packages/sdk-components-react/src/alert.tsx b/packages/sdk-components-react/src/alert.tsx
new file mode 100644
index 0000000000..6db41f0938
--- /dev/null
+++ b/packages/sdk-components-react/src/alert.tsx
@@ -0,0 +1,19 @@
+import { forwardRef, type ComponentProps, type ElementRef } from "react";
+
+export const defaultTag = "div";
+
+type Props = Omit<ComponentProps<typeof defaultTag>, "title"> & {
+ variant?: "note" | "tip" | "important" | "warning" | "caution";
+};
+
+export const Alert = forwardRef<ElementRef<typeof defaultTag>, Props>(
+ ({ variant = "note", role = "note", children, ...props }, ref) => {
+ return (
+ <div {...props} role={role} data-state={variant} ref={ref}>
+ {children}
+ </div>
+ );
+ }
+);
+
+Alert.displayName = "Alert";
diff --git a/packages/sdk-components-react/src/alert.ws.ts b/packages/sdk-components-react/src/alert.ws.ts
new file mode 100644
index 0000000000..6a2795b347
--- /dev/null
+++ b/packages/sdk-components-react/src/alert.ws.ts
@@ -0,0 +1,98 @@
+import { AlertIcon } from "@webstudio-is/icons/svg";
+import {
+ descendantComponent,
+ type PresetStyle,
+ type WsComponentMeta,
+} from "@webstudio-is/sdk";
+import { div } from "@webstudio-is/sdk/normalize.css";
+import { props } from "./__generated__/alert.props";
+import type { defaultTag } from "./alert";
+
+const presetStyle = {
+ div: [
+ ...div,
+ {
+ property: "padding-top",
+ value: { type: "unit", value: 16, unit: "px" },
+ },
+ {
+ property: "padding-right",
+ value: { type: "unit", value: 16, unit: "px" },
+ },
+ {
+ property: "padding-bottom",
+ value: { type: "unit", value: 16, unit: "px" },
+ },
+ {
+ property: "padding-left",
+ value: { type: "unit", value: 16, unit: "px" },
+ },
+ {
+ property: "border-top-left-radius",
+ value: { type: "unit", value: 8, unit: "px" },
+ },
+ {
+ property: "border-top-right-radius",
+ value: { type: "unit", value: 8, unit: "px" },
+ },
+ {
+ property: "border-bottom-right-radius",
+ value: { type: "unit", value: 8, unit: "px" },
+ },
+ {
+ property: "border-bottom-left-radius",
+ value: { type: "unit", value: 8, unit: "px" },
+ },
+ {
+ property: "background-color",
+ state: '[data-state="note"]',
+ value: { type: "rgb", r: 239, g: 246, b: 255, alpha: 1 },
+ },
+ {
+ property: "background-color",
+ state: '[data-state="tip"]',
+ value: { type: "rgb", r: 236, g: 253, b: 245, alpha: 1 },
+ },
+ {
+ property: "background-color",
+ state: '[data-state="important"]',
+ value: { type: "rgb", r: 238, g: 242, b: 255, alpha: 1 },
+ },
+ {
+ property: "background-color",
+ state: '[data-state="warning"]',
+ value: { type: "rgb", r: 254, g: 243, b: 199, alpha: 1 },
+ },
+ {
+ property: "background-color",
+ state: '[data-state="caution"]',
+ value: { type: "rgb", r: 254, g: 226, b: 226, alpha: 1 },
+ },
+ ],
+} satisfies PresetStyle<typeof defaultTag>;
+
+export const meta: WsComponentMeta = {
+ icon: AlertIcon,
+ description: "Highlight a note, tip, important detail, warning, or caution.",
+ contentModel: {
+ category: "instance",
+ children: ["instance", descendantComponent],
+ },
+ presetStyle,
+ states: [
+ { label: "Note", selector: '[data-state="note"]' },
+ { label: "Tip", selector: '[data-state="tip"]' },
+ { label: "Important", selector: '[data-state="important"]' },
+ { label: "Warning", selector: '[data-state="warning"]' },
+ { label: "Caution", selector: '[data-state="caution"]' },
+ ],
+ initialProps: ["variant", "id", "class"],
+ props: {
+ ...props,
+ variant: {
+ ...props.variant,
+ label: "Variant",
+ contentMode: true,
+ },
+ },
+};
diff --git a/packages/sdk-components-react/src/basic.template.tsx b/packages/sdk-components-react/src/basic.template.tsx
index 987506b60e..59ee6a0c50 100644
--- a/packages/sdk-components-react/src/basic.template.tsx
+++ b/packages/sdk-components-react/src/basic.template.tsx
@@ -6,6 +6,7 @@ import {
type TemplateMeta,
} from "@webstudio-is/template";
import {
+ Alert as AlertComponent,
Blockquote,
Bold,
Box,
@@ -39,6 +40,16 @@ import {
const sampleImage =
"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 640 360'%3E%3Crect width='640' height='360' fill='%23eef2ff'/%3E%3Cpath d='M96 264l120-120 88 88 56-56 184 184H96z' fill='%2394a3b8'/%3E%3Ccircle cx='456' cy='112' r='44' fill='%23f59e0b'/%3E%3C/svg%3E";
+export const Alert: TemplateMeta = {
+ category: "typography",
+ description: "Highlight information that deserves extra attention.",
+ template: (
+ <AlertComponent variant="note">
+ <Paragraph>{new PlaceholderValue("Add helpful context here.")}</Paragraph>
+ </AlertComponent>
+ ),
+};
+
const BlockquoteTemplate: TemplateMeta = {
category: "typography",
description: "A quoted customer insight or design principle.",
@@ -262,6 +273,7 @@ const VideoTemplate: TemplateMeta = {
};
export const templates = [
+ Alert,
BlockquoteTemplate,
BoldTemplate,
BoxTemplate,
diff --git a/packages/sdk-components-react/src/components.ts b/packages/sdk-components-react/src/components.ts
index 2e63cb6ac5..503ccd4c6e 100644
--- a/packages/sdk-components-react/src/components.ts
+++ b/packages/sdk-components-react/src/components.ts
@@ -2,6 +2,7 @@ export { Slot } from "./slot";
export { Fragment } from "./fragment";
export { HtmlEmbed } from "./html-embed";
export { MarkdownEmbed } from "./markdown-embed";
+export { Alert } from "./alert";
export { Body } from "./body";
export { Box } from "./box";
export { Text } from "./text";
diff --git a/packages/sdk-components-react/src/content-mode-props.test.ts b/packages/sdk-components-react/src/content-mode-props.test.ts
index 68a3fc59fe..13bfcc65f3 100644
--- a/packages/sdk-components-react/src/content-mode-props.test.ts
+++ b/packages/sdk-components-react/src/content-mode-props.test.ts
@@ -12,6 +12,7 @@ test("exposes only authored component content in Content mode", () => {
expect(contentModeProps.sort()).toEqual(
[
+ "Alert.variant",
"Button.aria-label",
"CodeText.language",
"HtmlEmbed.code",
diff --git a/packages/sdk-components-react/src/markdown-embed.template.tsx b/packages/sdk-components-react/src/markdown-embed.template.tsx
index 2a53ef1d1b..5bee17171c 100644
--- a/packages/sdk-components-react/src/markdown-embed.template.tsx
+++ b/packages/sdk-components-react/src/markdown-embed.template.tsx
@@ -2,6 +2,7 @@
import { type TemplateMeta, ws } from "@webstudio-is/template";
import { imagePlaceholderDataUrl } from "@webstudio-is/image";
import { MarkdownEmbed } from "./markdown-embed";
+import { markdownAlertStyle } from "./shared/markdown-alert-style";
const markdownSample = `
# Styling Markdown with Markdown Embed
@@ -38,6 +39,21 @@ Any elements that were not used above are used below.
> Capture attention with a powerful quote.
+> [!NOTE]
+> Add helpful context without interrupting the main content.
+
+> [!TIP]
+> Share a useful suggestion.
+
+> [!IMPORTANT]
+> Highlight essential information.
+
+> [!WARNING]
+> Point out something readers should be careful about.
+
+> [!CAUTION]
+> Explain a potential negative consequence.
+
Using \`console.log("Hello World");\` will log to the console.
| Header 1 | Header 2 | Header 3 |
@@ -65,6 +81,25 @@ export const meta: TemplateMeta = {
<ws.descendant ws:label="Link" selector=" a" />
<ws.descendant ws:label="Image" selector=" img" />
<ws.descendant ws:label="Blockquote" selector=" blockquote" />
+ <ws.descendant
+ ws:label="Alert"
+ selector=" [data-state]"
+ ws:style={markdownAlertStyle}
+ />
+ <ws.descendant ws:label="Note alert" selector={' [data-state="note"]'} />
+ <ws.descendant ws:label="Tip alert" selector={' [data-state="tip"]'} />
+ <ws.descendant
+ ws:label="Important alert"
+ selector={' [data-state="important"]'}
+ />
+ <ws.descendant
+ ws:label="Warning alert"
+ selector={' [data-state="warning"]'}
+ />
+ <ws.descendant
+ ws:label="Caution alert"
+ selector={' [data-state="caution"]'}
+ />
<ws.descendant ws:label="Code Text" selector=" code" />
<ws.descendant ws:label="List" selector=" :where(ul, ol)" />
<ws.descendant ws:label="List Item" selector=" li" />
diff --git a/packages/sdk-components-react/src/markdown-embed.test.tsx b/packages/sdk-components-react/src/markdown-embed.test.tsx
index ff2eb1a132..c8c034178f 100644
--- a/packages/sdk-components-react/src/markdown-embed.test.tsx
+++ b/packages/sdk-components-react/src/markdown-embed.test.tsx
@@ -108,6 +108,39 @@ Hello, world!
expect(html).toContain("<table>");
});
+ test.each(["note", "tip", "important", "warning", "caution"])(
+ "renders a GitHub-style %s alert",
+ (type) => {
+ const html = renderToStaticMarkup(
+ <MarkdownEmbed
+ code={`> [!${type.toUpperCase()}]\n> **Highlighted** content with a [link](https://example.com).\n>\n> - First item\n> - Second item\n>\n> [Unsafe](javascript:alert("unsafe"))`}
+ />
+ );
+
+ expect(html).toContain(`<div role="note" data-state="${type}">`);
+ expect(html).toContain(
+ '<p><strong>Highlighted</strong> content with a <a href="https://example.com">link</a>.</p>'
+ );
+ expect(html).toContain("<ul>");
+ expect(html).not.toContain(`[!${type.toUpperCase()}]`);
+ expect(html).not.toContain("javascript:");
+ }
+ );
+
+ test("preserves ordinary blockquotes for malformed and unsupported alerts", () => {
+ const html = renderToStaticMarkup(
+ <MarkdownEmbed
+ code={`> [!INFO]\n> Unsupported\n\n> Prefix [!NOTE]\n> Not at the start\n\n> [!note]\n> Wrong case\n\n> - Content before the marker\n>\n> [!NOTE]\n> Too late`}
+ />
+ );
+
+ expect(html.match(/<blockquote>/g)).toHaveLength(4);
+ expect(html).not.toContain("data-state");
+ expect(html).toContain("[!INFO]");
+ expect(html).toContain("Prefix [!NOTE]");
+ expect(html).toContain("[!note]");
+ });
+
test("does not render YAML frontmatter or treat it as a heading", () => {
const html = renderToStaticMarkup(
<MarkdownEmbed code={`---\ntitle: Hidden\n---\n# Visible`} />
diff --git a/packages/sdk-components-react/src/markdown.ts b/packages/sdk-components-react/src/markdown.ts
index 8fac1974a9..1215450869 100644
--- a/packages/sdk-components-react/src/markdown.ts
+++ b/packages/sdk-components-react/src/markdown.ts
@@ -1,25 +1,56 @@
-import { micromark } from "micromark";
-import { gfm, gfmHtml } from "micromark-extension-gfm";
+import { toHtml } from "hast-util-to-html";
+import { gfmFromMarkdown } from "mdast-util-gfm";
import { frontmatter } from "micromark-extension-frontmatter";
+import { gfm } from "micromark-extension-gfm";
import { fromMarkdown } from "mdast-util-from-markdown";
import { frontmatterFromMarkdown } from "mdast-util-frontmatter";
+import { toHast } from "mdast-util-to-hast";
import { toString } from "mdast-util-to-string";
import GithubSlugger from "github-slugger";
-import type { HtmlExtension } from "micromark-util-types";
import sanitizeHtml from "sanitize-html";
import type { ImageLoader } from "@webstudio-is/image";
+import {
+ getGithubAlertType,
+ transformGithubAlerts,
+} from "@webstudio-is/content-engine/remark-github-alerts";
import { getSdkImageProps, type SdkImageProps } from "./image-utils";
-const getHeadingIds = (markdown: string) => {
+const parseMarkdown = (markdown: string) => {
+ const tree = fromMarkdown(markdown, {
+ extensions: [frontmatter(["yaml"]), gfm()],
+ mdastExtensions: [frontmatterFromMarkdown(["yaml"]), gfmFromMarkdown()],
+ });
+ transformGithubAlerts(tree);
const slugger = new GithubSlugger();
- const ids: string[] = [];
const visit = (node: unknown) => {
if (typeof node !== "object" || node === null) {
return;
}
if ("type" in node && node.type === "heading") {
const text = toString(node as Parameters<typeof toString>[0]);
- ids.push(slugger.slug(text) || slugger.slug("heading"));
+ const data =
+ "data" in node && typeof node.data === "object" ? node.data : {};
+ Object.assign(node, {
+ data: {
+ ...data,
+ hProperties: { id: slugger.slug(text) || slugger.slug("heading") },
+ },
+ });
+ }
+ const alertType = getGithubAlertType(node);
+ if (alertType !== undefined) {
+ const data =
+ "data" in node && typeof node.data === "object" ? node.data : {};
+ Object.assign(node, {
+ data: {
+ ...data,
+ hName: "div",
+ hProperties: {
+ role: "note",
+ "data-state": alertType.toLowerCase(),
+ },
+ },
+ });
}
if ("children" in node && Array.isArray(node.children)) {
for (const child of node.children) {
@@ -27,43 +58,8 @@ const getHeadingIds = (markdown: string) => {
}
}
};
- visit(
- fromMarkdown(markdown, {
- extensions: [frontmatter(["yaml"])],
- mdastExtensions: [frontmatterFromMarkdown(["yaml"])],
- })
- );
- return ids;
-};
-
-const createHeadingIdsHtmlExtension = (
- headingIds: readonly string[]
-): HtmlExtension => {
- let headingIndex = 0;
- const takeHeadingId = () => headingIds[headingIndex++] ?? "heading";
- return {
- exit: {
- atxHeadingSequence(token) {
- if (this.getData("headingRank") !== undefined) {
- return;
- }
- const rank = this.sliceSerialize(token).length;
- this.setData("headingRank", rank);
- this.lineEndingIfNeeded();
- this.tag(`<h${rank} id="${this.encode(takeHeadingId())}">`);
- },
- setextHeading() {
- const value = this.resume();
- const rank = this.getData("headingRank");
- this.lineEndingIfNeeded();
- this.tag(`<h${rank} id="${this.encode(takeHeadingId())}">`);
- this.raw(value);
- this.tag(`</h${rank}>`);
- this.setData("slurpAllLineEndings");
- this.setData("headingRank");
- },
- },
- };
+ visit(tree);
+ return tree;
};
const sanitizeMarkdownHtml = (
@@ -194,16 +190,6 @@ const createImageTransformer =
return { tagName, attribs: transformedAttributes };
};
-const createGfmHtmlExtension = () => {
- const extension = gfmHtml();
- // GFM tag filtering escapes embedded HTML before our stricter sanitizer can
- // inspect it. Remove only those handlers and keep every other GFM renderer;
- // sanitizeMarkdownHtml remains the security boundary for embedded markup.
- delete extension.exit?.htmlFlowData;
- delete extension.exit?.htmlTextData;
- return extension;
-};
-
/** Shared safe renderer used by both the authoring preview and published component. */
export const renderMarkdownHtml = (
markdown: string,
@@ -217,16 +203,10 @@ export const renderMarkdownHtml = (
renderer?: "canvas" | "preview";
} = {}
) => {
+ const tree = parseMarkdown(markdown);
+ const hast = toHast(tree, { allowDangerousHtml: true });
const html = sanitizeMarkdownHtml(
- micromark(markdown, {
- allowDangerousHtml: true,
- allowDangerousProtocol: true,
- extensions: [frontmatter(["yaml"]), gfm()],
- htmlExtensions: [
- createGfmHtmlExtension(),
- createHeadingIdsHtmlExtension(getHeadingIds(markdown)),
- ],
- }),
+ hast === undefined ? "" : toHtml(hast, { allowDangerousHtml: true }),
{ allowBlobImages }
);
diff --git a/packages/sdk-components-react/src/metas.ts b/packages/sdk-components-react/src/metas.ts
index c4f961300c..0727205343 100644
--- a/packages/sdk-components-react/src/metas.ts
+++ b/packages/sdk-components-react/src/metas.ts
@@ -2,6 +2,7 @@ export { meta as Slot } from "./slot.ws";
export { meta as Fragment } from "./fragment.ws";
export { meta as HtmlEmbed } from "./html-embed.ws";
export { meta as MarkdownEmbed } from "./markdown-embed.ws";
+export { meta as Alert } from "./alert.ws";
export { meta as Body } from "./body.ws";
export { meta as Box } from "./box.ws";
export { meta as Text } from "./text.ws";
diff --git a/packages/sdk-components-react/src/shared/markdown-alert-style.ts b/packages/sdk-components-react/src/shared/markdown-alert-style.ts
new file mode 100644
index 0000000000..4cf632ee0a
--- /dev/null
+++ b/packages/sdk-components-react/src/shared/markdown-alert-style.ts
@@ -0,0 +1,21 @@
+import { css } from "@webstudio-is/template";
+
+export const markdownAlertStyle = css`
+ padding: 16px;
+ border-radius: 8px;
+ &[data-state="note"] {
+ background-color: #eff6ff;
+ }
+ &[data-state="tip"] {
+ background-color: #ecfdf5;
+ }
+ &[data-state="important"] {
+ background-color: #eef2ff;
+ }
+ &[data-state="warning"] {
+ background-color: #fef3c7;
+ }
+ &[data-state="caution"] {
+ background-color: #fee2e2;
+ }
+`;
diff --git a/packages/sdk-components-react/src/templates.ts b/packages/sdk-components-react/src/templates.ts
index 48c3633a58..5c45075ad2 100644
--- a/packages/sdk-components-react/src/templates.ts
+++ b/packages/sdk-components-react/src/templates.ts
@@ -4,3 +4,4 @@ export { meta as Form } from "./webhook-form.template";
export { meta as Vimeo } from "./vimeo.template";
export { meta as YouTube } from "./youtube.template";
export { meta as HeadSlot } from "./head-slot.template";
+export { Alert } from "./basic.template";
diff --git a/packages/sdk-components-registry/src/core-templates.test.tsx b/packages/sdk-components-registry/src/core-templates.test.tsx
index 04c215d8b4..66fea60b3e 100644
--- a/packages/sdk-components-registry/src/core-templates.test.tsx
+++ b/packages/sdk-components-registry/src/core-templates.test.tsx
@@ -72,6 +72,30 @@ test("keeps the Content Block Image template free of local styles", () => {
).toEqual([]);
});
+test("gives the Content Block Alert template sample text", () => {
+ const fragment = renderCoreTemplate(coreTemplates[blockComponent]);
+ const instances = new Map(
+ fragment.instances.map((instance) => [instance.id, instance])
+ );
+ const alert = fragment.instances.find(
+ ({ component }) => component === "Alert"
+ );
+ const paragraphChild = alert?.children[0];
+ const paragraph =
+ paragraphChild?.type === "id"
+ ? instances.get(paragraphChild.value)
+ : undefined;
+
+ expect(paragraph?.component).toBe("Paragraph");
+ expect(paragraph?.children).toEqual([
+ {
+ type: "text",
+ value: "Add helpful context here.",
+ placeholder: true,
+ },
+ ]);
+});
+
test("generates ordered semantic defaults from their descriptors", () => {
const fragment = renderCoreTemplate(coreTemplates[blockComponent]);
const instances = new Map(
diff --git a/packages/sdk-components-registry/src/core-templates.tsx b/packages/sdk-components-registry/src/core-templates.tsx
index 4a8bbad43d..cb228a6752 100644
--- a/packages/sdk-components-registry/src/core-templates.tsx
+++ b/packages/sdk-components-registry/src/core-templates.tsx
@@ -1,6 +1,6 @@
/** @jsxImportSource @webstudio-is/template */
/** Assembles core templates that depend on registered React components. */
-import { createElement, type ElementType } from "react";
+import { createElement, type ElementType, type ReactNode } from "react";
import { Webstudio1cIcon } from "@webstudio-is/icons/svg";
import {
blockComponent,
@@ -14,6 +14,7 @@ import { intrinsicCoreTemplates } from "@webstudio-is/sdk/core-templates";
import {
css,
Parameter,
+ PlaceholderValue,
setInstanceMeta,
setTemplateMeta,
type TemplateMeta,
@@ -22,6 +23,7 @@ import {
import {
CodeText,
HtmlEmbed,
+ Paragraph,
} from "@webstudio-is/sdk-components-react/components";
import { componentsById } from "./components";
@@ -65,6 +67,18 @@ const createContentBlockMdxTemplate = (
`Content Block component template "${descriptor.component}" is not registered`
);
}
+ const children =
+ descriptor.component === "CodeText"
+ ? 'const status = "ready";'
+ : descriptor.component === "Alert"
+ ? createElement(
+ Paragraph,
+ undefined,
+ new PlaceholderValue(
+ "Add helpful context here."
+ ) as unknown as ReactNode
+ )
+ : undefined;
return setTemplateMeta(
{
name: getDefaultContentBlockTemplateName({
@@ -75,9 +89,7 @@ const createContentBlockMdxTemplate = (
createElement(
component as ElementType,
{ key: descriptor.resolutionKey },
- descriptor.component === "CodeText"
- ? 'const status = "ready";'
- : undefined
+ children
)
);
};
diff --git a/packages/sdk/src/content-block.ts b/packages/sdk/src/content-block.ts
index 1c055b061f..cd38772985 100644
--- a/packages/sdk/src/content-block.ts
+++ b/packages/sdk/src/content-block.ts
@@ -91,6 +91,7 @@ export const contentBlockMdxTemplateDescriptors = [
defineMdxElementTemplate("li", "List Item", false),
defineMdxElementTemplate("a", "Link", true),
defineMdxComponentTemplate("Image", "Image", true),
+ defineMdxComponentTemplate("Alert", "Alert", true),
defineMdxElementTemplate("hr", "Separator", true),
defineMdxElementTemplate("br", "Line Break", false),
defineMdxElementTemplate("blockquote", "Blockquote", true),
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 32c13d1cb3..512e13df7c 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -2740,6 +2740,9 @@ importers:
'@shikijs/themes':
specifier: 4.4.1
version: 4.4.1
+ '@webstudio-is/content-engine':
+ specifier: workspace:*
+ version: link:../content-engine
'@webstudio-is/icons':
specifier: workspace:*
version: link:../icons
@@ -2764,6 +2767,9 @@ importers:
github-slugger:
specifier: 2.0.0
version: 2.0.0
+ hast-util-to-html:
+ specifier: 9.0.5
+ version: 9.0.5
hast-util-to-jsx-runtime:
specifier: ^2.3.6
version: 2.3.6
@@ -2773,12 +2779,15 @@ importers:
mdast-util-frontmatter:
specifier: 2.0.1
version: 2.0.1
+ mdast-util-gfm:
+ specifier: 3.1.0
+ version: 3.1.0
+ mdast-util-to-hast:
+ specifier: 13.2.1
+ version: 13.2.1
mdast-util-to-string:
specifier: 4.0.0
version: 4.0.0
- micromark:
- specifier: ^4.0.2
- version: 4.0.2
micromark-extension-frontmatter:
specifier: 2.0.0
version: 2.0.0
@@ -2825,9 +2834,6 @@ importers:
'@webstudio-is/tsconfig':
specifier: workspace:*
version: link:../tsconfig
- micromark-util-types:
- specifier: 2.0.2
- version: 2.0.2
nanostores:
specifier: ^0.11.3
version: 0.11.3
@@ -9844,6 +9850,9 @@ packages:
resolution: {integrity: sha512-MTtdFRz/eMDHXzeK6W3dO7mXUlF82Gom4y0oOgvHhh/HXZAGvIQDUvQ0SuUx+j2tv44b8xTHOm8K/9OoRFnXKw==}
+ resolution: {integrity: sha512-Tmd1Vg/m3Xz43afeNxDIhWRtFZgM2VLyaf4vSTYwudTyeuTneoL3qtWMA5jeLyz/O1vDJmmV4QuScFCA2tBPwg==}
+
resolution: {integrity: sha512-4xTO/M8c82qBcnQc1tgpNtubGUW/Y1tBQ1B0i5CtSoelOLKFYlElIr3bvgREYYO5iRqbMY1YuqZng0GVOI8Qww==}
@@ -9859,21 +9868,39 @@ packages:
resolution: {integrity: sha512-My8KJ57FYEy2W2LyNom4n3E7hKTuQk/0SES0u16tjA9Z3oFkF4RrC/hPAPgjlSpezsOvI8ObcXcElo92wn5IGA==}
+ resolution: {integrity: sha512-5HVP2MKaP6L+G6YaxPNjuL0BPrq9orG3TsrZ9YXbA3vDw/ACI4MEsnoDpn6ZNm7GnZgtAcONJyPhOP8tNJQavQ==}
+
resolution: {integrity: sha512-56D19KOGbE00uKVj3sgIykpwKL179QsVFwx/DCW0u/0+URsryacI4MAdNJl0dh+u2PSsD9FtxPFbHCzJ78qJFQ==}
+ resolution: {integrity: sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ==}
+
resolution: {integrity: sha512-DAPhYzTYrRcXdMjUtUjKvW9z/FNAMTdU0ORyMcbmkwYNbKocDpdk+PX1L1dQgOID/+vVs1uBQ7ElrBQfZ0cuiQ==}
+ resolution: {integrity: sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg==}
+
resolution: {integrity: sha512-jjcpmNnQvrmN5Vx7y7lEc2iIOEytYv7rTvu+MeyAsSHTASGCCRA79Igg2uKssgOs1i1po8s3plW0sTu1wkkLGg==}
+ resolution: {integrity: sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg==}
+
resolution: {integrity: sha512-PFTA1gzfp1B1UaiJVyhJZA1rm0+Tzn690frc/L8vNX1Jop4STZgOE6bxUhnzdVSB+vm2GU1tIsuQcA9bxTQpMQ==}
+ resolution: {integrity: sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ==}
+
resolution: {integrity: sha512-qvZ608nBppZ4icQlhQQIAdc6S3Ffj9RGmzwUKUWuEICFnd1LVkN3EktF7ZHAgfcEdvZB5owU9tQgt99e2TlLjg==}
+ resolution: {integrity: sha512-0ulfdQOM3ysHhCJ1p06l0b0VKlhU0wuQs3thxZQagjcjPrlFRqY215uZGHHJan9GEAXd9MbfPjFJz+qMkVR6zQ==}
+
resolution: {integrity: sha512-xIPmR5ReJDu/DHH1OoIT1HkuybIfRGYRywC+gJtI7qHjCJp/M9jrmBEJW22O8lskDWm562BX2W8TiAwRTb0rKA==}
@@ -19956,6 +19983,13 @@ snapshots:
unist-util-is: 5.2.0
unist-util-visit-parents: 5.1.3
+ dependencies:
+ '@types/mdast': 4.0.4
+ escape-string-regexp: 5.0.0
+ unist-util-is: 6.0.1
+ unist-util-visit-parents: 6.0.2
+
dependencies:
'@types/mdast': 3.0.15
@@ -20014,17 +20048,43 @@ snapshots:
mdast-util-find-and-replace: 2.2.2
micromark-util-character: 1.2.0
+ dependencies:
+ '@types/mdast': 4.0.4
+ ccount: 2.0.1
+ devlop: 1.1.0
+ mdast-util-find-and-replace: 3.0.2
+ micromark-util-character: 2.1.1
+
dependencies:
'@types/mdast': 3.0.15
mdast-util-to-markdown: 1.5.0
micromark-util-normalize-identifier: 1.1.0
+ dependencies:
+ '@types/mdast': 4.0.4
+ devlop: 1.1.0
+ mdast-util-from-markdown: 2.0.3
+ mdast-util-to-markdown: 2.1.2
+ micromark-util-normalize-identifier: 2.0.1
+ transitivePeerDependencies:
+ - supports-color
+
dependencies:
'@types/mdast': 3.0.15
mdast-util-to-markdown: 1.5.0
+ dependencies:
+ '@types/mdast': 4.0.4
+ mdast-util-from-markdown: 2.0.3
+ mdast-util-to-markdown: 2.1.2
+ transitivePeerDependencies:
+ - supports-color
+
dependencies:
'@types/mdast': 3.0.15
@@ -20034,11 +20094,30 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ dependencies:
+ '@types/mdast': 4.0.4
+ devlop: 1.1.0
+ markdown-table: 3.0.4
+ mdast-util-from-markdown: 2.0.3
+ mdast-util-to-markdown: 2.1.2
+ transitivePeerDependencies:
+ - supports-color
+
dependencies:
'@types/mdast': 3.0.15
mdast-util-to-markdown: 1.5.0
+ dependencies:
+ '@types/mdast': 4.0.4
+ devlop: 1.1.0
+ mdast-util-from-markdown: 2.0.3
+ mdast-util-to-markdown: 2.1.2
+ transitivePeerDependencies:
+ - supports-color
+
dependencies:
mdast-util-from-markdown: 1.3.1
@@ -20051,6 +20130,18 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ dependencies:
+ mdast-util-from-markdown: 2.0.3
+ mdast-util-gfm-autolink-literal: 2.0.1
+ mdast-util-gfm-footnote: 2.1.0
+ mdast-util-gfm-strikethrough: 2.0.0
+ mdast-util-gfm-table: 2.0.0
+ mdast-util-gfm-task-list-item: 2.0.0
+ mdast-util-to-markdown: 2.1.2
+ transitivePeerDependencies:
+ - supports-color
+
dependencies:
'@types/estree-jsx': 1.0.0