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/internal__plugin-state
internal__plugin-state package
Interfaces
| Interface | Description |
|---|---|
| FocusableChild | Describes a child document |
| PluginProps | |
| StateType | Describes the states of a [[Plugin]]. Please note that a state type will be recreated in every render. |
| StoreDeserializeHelpers | Helpers to be used by a [[StateType]] when working with a serialized state |
| StoreSerializeHelpers | Helpers to be used by a [[StateType]] when working with a deserialized state |
Type Aliases
| Type Alias | Description |
|---|---|
| StateExecutor | Describes an asynchronous state update |
| StateTypeReturnType | Maps a [[StateType]] to the type of its public API for usage in plugin components |
| StateTypeSerializedType | Maps a [[StateType]] to the type of its serialized state |
| StateTypesReturnType | |
| StateTypesSerializedType | |
| StateTypesValueType | |
| StateTypeValueType | Maps a [[StateType]] to the type of its deserialized state |
| StateUpdater | An updater will get called with the current state and helpers and should return the new state |