The API reference is a Work in Progress and will be continuously improved and extended. We'd love to hear your feedback in our documentation repository.

Home > @edtr-io/core

core package

Functions

FunctionDescription
Document_2(props)(BETA) Renders an editor for an Edtr.io document
Editor(props)Renders a single editor for an Edtr.io document
EditorProvider(props)(BETA) Hydrates the required contexts
OverlayButton(props)Renders the OverlayButton
OverlayCheckbox(props)Renders the OverlayCheckbox
OverlayInput(props)Renders the OverlayInput
OverlaySelect(props)Renders the OverlaySelect
OverlayTextarea(props)Renders the OverlayTextarea
PluginToolbarOverlayButton(props)Renders the PluginToolbarOverlayButton
Provider(props)Store Provider
setDefaultPreference(key, val)(BETA) Sets a preference
useScope(enforcedScope)
useScopedDispatch(enforcedScope)React Hook to dispatch an action in the current scope
useScopedSelector(scopedSelector, enforcedScope)React Hook to get the value of an selector in the current scope
useScopedStore(enforcedScope)React Hook to obtain a reference to the scoped store

Interfaces

InterfaceDescription
EditorProps
EditorProviderProps
Preference(BETA)
SubDocumentProps

Variables

VariableDescription
DocumentEditorContext
ErrorContext
PluginToolbarButtonRenders the PluginToolbarButton
PluginToolbarContext
PreferenceContext(BETA)
ScopeContext
SubDocumentRenders a document inside another document
useDispatch
useSelector
useStore

Type Aliases

Type AliasDescription
OverlayButtonProps
OverlayCheckboxProps
OverlayInputProps
OverlaySelectProps
OverlayTextareaProps
PluginToolbarButtonProps
PluginToolbarOverlayButtonProps