• English
  • Plugin matrix

    Choose a component

    ComponentEntryDefault features
    Fluxdown@fluxdown/react-native or @fluxdown/react-native/fullAdds syntax highlighting, Mermaid diagrams, SVG math, CJK, and Emoji.
    FluxdownLite@fluxdown/react-native/liteBasic Markdown, tables, images, and streaming effects; code and math display their source.
    FluxdownRaw@fluxdown/react-native/rawProvide the complete plugins set yourself.

    Full uses react-native-code-highlighter for code, the parser and layout from @osuki-dev/skia-diagrams for diagrams, and MathJax 3 SVG output for math. react-native-svg draws diagrams and formulas.

    Math requires build.tex, which defaults to false. Use fenced code blocks marked mermaid for diagrams. Unsupported diagram types retain their source.

    Full and Lite require react-native-svg 15.16 or later for streaming effects. Raw uses the plugins you supply; install it when adding these effects, math, or diagram plugins.

    All plugins

    Composition includes inherited plugin types. A check marks a direct preset entry. Full's highlighter and formula plugins inherit the basic Code and Tex behavior.

    PluginCompositionPackageLiteFull
    BlockquotePluginRender Slotreact-native-plugins
    BreakLinePluginRender Slotreact-native-plugins
    CjkPluginRemarkreact-base-plugins
    CodePluginRender Slotreact-native-plugins
    CodeHighlightPluginRender Slotreact-native-plugins
    CodeMermaidPluginSlotreact-native-plugins
    EffectChunkPluginRender Slotreact-native-plugins
    EffectScalePluginRender Slotreact-native-plugins
    EffectShadPluginRender Slotreact-native-plugins
    EffectSuffixPluginRender Slotreact-native-plugins
    EmojiPluginRemarkreact-base-plugins
    EmphasisPluginRender Slotreact-native-plugins
    FallbackPluginRender Slotreact-native-plugins
    HeadingPluginRender Slotreact-native-plugins
    ImagePluginRender Slotreact-native-plugins
    LinkPluginRender Slotreact-native-plugins
    ListPluginRender Slotreact-native-plugins
    ParagraphPluginRender Slotreact-native-plugins
    PatchPluginRenderreact-base-plugins
    StrongPluginRender Slotreact-native-plugins
    TablePluginRender Slotreact-native-plugins
    TexPluginRender Slotreact-native-plugins
    TexSvgPluginRender Slotreact-native-plugins

    Packages and imports

    • react-native-plugins means @fluxdown/react-native-plugins, with native slots and their composite plugins.
    • react-base-plugins means @fluxdown/react-base-plugins, with plugins independent of the presentation platform.

    Import from <package>/plugins/<plugin-directory>. Remove Plugin from the export name and convert it to lowercase words separated by hyphens: CodeHighlightPlugin becomes code-highlight.

    import { CodeHighlightPlugin } from '@fluxdown/react-native-plugins/plugins/code-highlight';
    import { CjkPlugin } from '@fluxdown/react-base-plugins/plugins/cjk';

    Extend either preset through the plugins prop. See composite plugins for configuration and composition.