Skip to content

CMS-46488 Enhance RichText documentation and update renderer to remove SVG support #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 10, 2025
Merged

CMS-46488 Enhance RichText documentation and update renderer to remove SVG support #166

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cab7916
CMS-46488 Enhance RichText documentation and update renderer to remov…
TRomesh Nov 7, 2025
c21a13c
Merge branch 'main' into bugfix/CMS-46488-remove-svg-support
TRomesh Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/6.1-richtext-component-react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,17 @@ Custom React components for rendering specific element types. Allows you to over
- **Headings:** `heading-one`, `heading-two`, `heading-three`, `heading-four`, `heading-five`, `heading-six`
- **Text blocks:** `paragraph`, `quote`, `pre`, `div`
- **Lists:** `bulleted-list`, `numbered-list`, `list-item`
- **Inline:** `link`, `code`, `mark`, `sup`, `sub`, `ins`, `del`, `br`
- **Tables:** `table`, `tbody`, `tr`, `th`, `td`
- **Media:** `image`
- **Text semantics (inline):** `span`, `mark`, `strong`, `em`, `u`, `s`, `i`, `b`, `small`, `sub`, `sup`, `ins`, `del`, `kbd`, `abbr`, `cite`, `dfn`, `q`, `data`, `bdo`, `bdi`
- **Code-related:** `code`, `pre`, `var`, `samp`
- **Links & Interactive:** `link`, `a`, `button`, `label`
- **Tables:** `table`, `thead`, `tbody`, `tfoot`, `caption`, `tr`, `th`, `td`
- **Media:** `image`, `img`, `canvas`
- **Forms:** `input`, `select`, `option`, `textarea`
- **Other:** `br`, `wbr`

> [!NOTE] > **SVG elements are not supported by default.** SVG requires specialized child elements (`circle`, `path`, `rect`, etc.) and attributes that would require extensive additional support.
>
> **Alternatives:** Use custom element handlers, upload SVG as image assets, or create dedicated React components.

#### Example: Custom Elements

Expand Down
1 change: 0 additions & 1 deletion packages/optimizely-cms-sdk/src/components/richText/renderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,6 @@ export const defaultElementTypeMap: Record<
// Media (when inline)
image: { tag: 'img', config: { selfClosing: true } },
img: { tag: 'img', config: { selfClosing: true } },
svg: { tag: 'svg' },
canvas: { tag: 'canvas' },

// Form elements
Expand Down