• English
  • Configuration

    Basic usage follows React. The table links to the full reference for each prop; platform-specific style usage is covered below.

    PropTypeDefault and purpose
    textstringRequired. The complete current Markdown.
    streamingboolean | StreamingConfigfalse. Ending repair, smoothing, and effects.
    buildBaseBuildConfig{}. Parsing features such as math and footnotes.
    themeTheme'light'. A preset or partial overrides; see the styling guide.
    pluginsIPluginItem | IPluginItem[][]. Extends this platform’s preset; required for Raw.
    patchesIPatchItem<ReactNode>[][]. Inserts or replaces text with ReactLynx content.
    classNamestringundefined. Class name on the outer view.
    styleCSSPropertiesundefined. Lynx styles on the outer view.
    refRef<FluxdownRef>undefined. A handle to reactive render output, not a native view reference.
    Imports

    Import BaseBuildConfig, StreamingConfig and FluxdownRef from @fluxdown/lynx; Theme and IPluginItem from @fluxdown/lynx-plugins/typings; CSSProperties from @lynx-js/types; and ReactNode from @lynx-js/react.

    style Optional

    Type: CSSProperties

    Default: undefined

    A Lynx style object on the outer view. Properties and values follow Lynx CSS. Use className to apply styles from your app:

    <Fluxdown
      className="conversation-message"
      style={{ padding: '16px', maxWidth: '720px' }}
      text={text}
    />

    See the styling guide for colors and typography within the content, and slot plugins to change components or interactions.