The ComposerPostPreview component renders Markdown as HTML using the TextFormatter library, polling a data source for changes every 50ms. This is done to prevent expensive redraws on e.g. every single keystroke, while still retaining the perception of live updates for the user.


  • composer The state of the composer controlling this preview.
  • className A CSS class for the element surrounding the preview.
  • surround A callback that can execute code before and after re-render, e.g. for scroll anchoring.




The attributes passed into the component.

element: Element

The root DOM element for the component.

state: undefined

Class component state that is persisted between redraws.

Updating this will not automatically trigger a redraw, unlike other frameworks.

This is different to Vnode state, which is always an instance of your class component.

This is undefined by default.

updateInterval: undefined | Timer


  • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

    For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.


    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node


Generated using TypeDoc v0.24.8