Markdown の API · Needless UI

インポート

import-markdown.ts

import { NuiMarkdown } from '@needless-ui/angular/markdown';

Markdown を要素としてレンダリングします。

NuiMarkdown: プロパティ
名前	型	デフォルト	説明
`text`入力	`string`	`''`	Markdown のテキスト。
`streaming`入力	`boolean`	`false`	テキストがまだ届いている途中かどうか。
`headingLevel`入力	`number`	`3`	`#` の見出しのレベル。より深い見出しは順に下がり、最大で 6 になります。
`images`入力	`boolean`	`false`	画像を表示します。画像は追跡に使われることがあるため、オフのときは画像のテキストがリンクになります。
`labels`入力	`Partial<NuiMarkdownLabels>`		コピーボタンのテキストなど。翻訳に使います。
`codeTemplate`入力	`TemplateRef \| null`	`null`	ほかの場所から渡すコードブロックのテンプレート。たとえば、これを含むチャットから渡します。

コードブロックを描画します。コンテキストには、コード、lang、ブロックの受信中は open が入っています。

パーサーとそのヘルパー。コンポーネントなしで使えます。

nuiParseMarkdown: プロパティ
名前	型	説明
`nuiParseMarkdown`メソッド	`(text, { streaming? }) => NuiMarkdownBlock[]`	コンポーネントが描画する、ブロック要素とインライン要素のツリー。
`nuiMarkdownToText`メソッド	`(text) => string`	ブロックごとに1行のプレーンテキスト。読み上げやプレビューに使います。
`nuiSafeUrl`メソッド	`(url) => boolean`	リンク先が Web、メール、電話のアドレスかどうか。