Namespace LocalizedMarkdown

A React component that combines localization with markdown rendering.

This component automatically handles the localization of markdown content using nls.localize and then renders it using the Markdown component.

Example: Basic usage

<LocalizedMarkdown
  localizationKey="theia/mypackage/welcome"
  defaultMarkdown="Welcome to **Theia**!"
  markdownRenderer={this.markdownRenderer}
  className="welcome-message"
/>

Example: With parameters

<LocalizedMarkdown
  localizationKey="theia/mypackage/greeting"
  defaultMarkdown="Hello **{0}**! You have {1} new messages."
  args={['Alice', 5]}
  markdownRenderer={this.markdownRenderer}
/>

Example: With command links

<LocalizedMarkdown
  localizationKey="theia/mypackage/settings"
  defaultMarkdown="Open [settings]({0}) to configure."
  args={[`command:${CommonCommands.OPEN_PREFERENCES.id}`]}
  markdownRenderer={this.markdownRenderer}
  markdownOptions={{
    isTrusted: { enabledCommands: [CommonCommands.OPEN_PREFERENCES.id] }
  }}
/>

Variables

displayName