Editor

Interfaces

EditorProps

Properties

Property	Type	Description
action?	ReactNode	Action to add to actions
className?	string	Overrides or extends the styles applied to the component. Default null
defaultValue?	string	Default value for the editor Default null
editable?	boolean	Is the content of the editor read only Default true
id?	string	Id of the feed object Default 'poll'
isLessonCommentEditor?	boolean	Prop to customize emoji plugin position Default false
MediaPluginProps?	MediaPluginProps	Props to spread to MediaPlugin. Default {}
onBlur?	(event) => void	Handler for blur event of the editor Default null
onChange?	(value) => void	Handler for change event of the editor Default null
onFocus?	(event) => void	Handler for focus event of the editor Default null
onMediaChange?	(media) => void	Handler for change media in the editor Default null
placeholder?	ReactNode	The text displayed when the editor is empty Default <FormattedMessage id="ui.editor.placeholder" defaultMessage="ui.editor.placeholder" />
toolbar?	boolean	Show the toolbar on top of the editor, elsewhere show buttons at the bottom of the editor Default false
ToolBarProps?	ToolbarPluginProps	Props to spread to ToolBar. Default {}
uploadFile?	boolean	This editor can upload files Default false
uploadImage?	boolean	This editor can upload images and insert into the html dom Default false

Type Aliases

EditorRef

EditorRef = object

Properties

Property	Type
focus	() => void

Variables

editor

editor: ForwardRefExoticComponent<EditorProps & RefAttributes<EditorRef>>

Functions

EditorSkeleton()

EditorSkeleton(): Element

API documentation for the Community-JS Editor Skeleton component. Learn about the available props and the CSS API.

Import

import {EditorSkeleton} from '@selfcommunity/react-ui';

Component Name

The name SCEditor-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule Name	Global class	Description
root	.SCEditor-skeleton-root	Styles applied to the root element.

Returns

Element