Package com.flowingcode.vaadin.addons.markdown

Class BaseMarkdownComponent

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.react.ReactAdapterComponent

com.flowingcode.vaadin.addons.markdown.BaseMarkdownComponent

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, Serializable

Direct Known Subclasses:

MarkdownEditor, MarkdownViewer

@CssImport("./styles/markdown-editor-styles.css")
@NpmPackage(value="mermaid",version="11.2.1") @NpmPackage(value="@uiw/react-md-editor",version="4.0.4") @NpmPackage(value="dompurify",version="3.1.6")
public class BaseMarkdownComponent
extends ReactAdapterComponent
implements HasSize

Base class for Markdown based Components.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BaseMarkdownComponent.DataColorMode	Defines the color schemes for the Markdown component.

Constructor Summary

Constructors

Constructor	Description
BaseMarkdownComponent(String content)	Base constructor that receives the content of the markdown component.

Method Summary

Modifier and Type	Method	Description
void	addContentChangeListener(SerializableConsumer<String> listener)	Adds the specified listener for the content change event.
String	getContent()	Sets the content of the Markdown component.
void	setContent(String content)	Gets the content of the Markdown component.
void	setDataColorMode(BaseMarkdownComponent.DataColorMode mode)	Sets the color mode of the Markdown component.

Methods inherited from class com.vaadin.flow.component.react.ReactAdapterComponent

addStateChangeListener, addStateChangeListener, getState, getState, readFromJson, readFromJson, setState, writeAsJson

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

BaseMarkdownComponent

public BaseMarkdownComponent(String content)

Base constructor that receives the content of the markdown component.

Parameters:

content - content to be used in the Markdown component

Method Details

getContent

public String getContent()

Sets the content of the Markdown component.

Returns:

the content of the Markdown component

setContent

public void setContent(String content)

Gets the content of the Markdown component.

Parameters:

content - retrieved from the state of the component

addContentChangeListener

public void addContentChangeListener(SerializableConsumer<String> listener)

Adds the specified listener for the content change event.

Parameters:

listener - the listener callback for receiving content changes

setDataColorMode

public void setDataColorMode(BaseMarkdownComponent.DataColorMode mode)

Sets the color mode of the Markdown component.

Parameters:

mode - the color mode of the component