Edtr.io
DocumentationAPIBlog
v2.0.0GitHub

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/plugin

plugin package

Functions

FunctionDescription
asyncScalar(initial, isTemporaryValue)
boolean(initialValue)
child(params)
isTempFile(state)
list(type, initialCount)
migratable(type)
number(initialValue)
object(types, getFocusableChildren)
optional(type, initiallyDefined)
scalar(initialState)
serializedScalar(initialState, serializer)
string(initialValue)
upload(defaultState)
usePendingFilesUploader(files, uploadHandler)
usePendingFileUploader(file, uploadHandler)

Interfaces

InterfaceDescription
ChildStateTypeConfig
LoadedFile
MigratableStateType
Serializer
TempFile
UploadStateReturnType
Versionized

Type Aliases

Type AliasDescription
AsyncScalarStateType
BooleanStateType
ChildStateType
EditorPlugin
EditorPluginProps
FileState
FocusableChild
ListStateType
NumberStateType
ObjectStateType
Optional
OptionalStateType
PluginProps
ScalarStateType
SerializedScalarStateType
StateExecutor
StateType
StateTypeReturnType
StateTypeSerializedType
StateTypesReturnType
StateTypesSerializedType
StateTypesValueType
StateTypeValueType
StateUpdater
StoreDeserializeHelpers
StoreSerializeHelpers
StringStateType
UploadHandler
UploadStateType
UploadValidator
Privacy
Imprint

© 2026 Serlo Education e.V.

API Reference@edtr-io/core@edtr-io/default-document-editor@edtr-io/default-plugin-toolbar@edtr-io/document-editor@edtr-io/editor-ui@edtr-io/math@edtr-io/plugin@edtr-io/renderer-ssr@edtr-io/renderer-ui@edtr-io/renderer@edtr-io/store-devtools@edtr-io/store@edtr-io/ui@edtr-io/plugin-anchor@edtr-io/plugin-blockquote@edtr-io/plugin-files@edtr-io/plugin-geogebra@edtr-io/plugin-highlight@edtr-io/plugin-image@edtr-io/plugin-input-exercise@edtr-io/plugin-multimedia-explanation@edtr-io/plugin-rows@edtr-io/plugin-sc-mc-exercise@edtr-io/plugin-serlo-injection@edtr-io/plugin-spoiler@edtr-io/plugin-table@edtr-io/plugin-text@edtr-io/plugin-toolbar@edtr-io/plugin-video