Skip to content
DocsReference
DocsReferenceGitHub

Search Ridu documentation

tab controls

Loading search…

Search will be ready in a moment.

No matching results

Try a different term or search every section.

Loading search.

Preparing index…View all results →↑↓ move↵ openesc close
Get started
Modules/@riducms/sdk
FrenderRichTextHTML

Go packages

riducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestconformance

Official adapters

postgressqlitemongodbstorage/localstorage/s3

Official plugins

graphqlmcprichtextseoformbuilder@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/plugin-graphql

TypeScript packages

@riducms/sdk@riducms/sveltekit@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/admin@riducms/translations@riducms/cli/run

Tooling

ridu CLI
All@riducms/sdkriducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestpostgressqlitemongodbgraphqlmcprichtextseoformbuilderstorage/localstorage/s3conformance@riducms/sveltekit@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/plugin-graphql@riducms/admin@riducms/translations@riducms/cli/runridu CLI
All 195MutationOptionsconvertLexicalToPlaintextdocumentRecoveryIssueescapeRichTextrenderRichTextHTMLrenderRichTextTextrichTextElementTagsafeRichTextURL

function

renderRichTextHTML

Pure synchronous rendering: no editor bundle, DOM, Svelte dependency or network requests.

ArgumentsReturnsFull signature

Arguments

ArgumentTypeDescription
valueRichTextDocument<Payload>The value value.
optionsRichTextRenderOptions<Payload>The options value.

Returns

The declared result.

string

Full signature

function renderRichTextHTML<Payload extends { blockType: string } = never>( value: RichTextDocument<Payload>, options?: RichTextRenderOptions<Payload>, ): string

Source packages/sdk/src/richtext/index.ts:19

Related types

  • RichTextDocument

    The portable TypeScript contract for stored version-1 rich text.

  • RichTextRenderOptions

    Public interface RichTextRenderOptions from @riducms/sdk.