@modular/sdk/editor
31 exports in 4 groups.
Interfaces22
- EditorExternalFrameAllowedResultinterfaceallowed, src, trustedDomains
- EditorExternalFrameCapabilityinterfacegetTrustedDomains(), onDidChangeTrustedDomains(), validateSrc()
- EditorExternalFrameDeniedResultinterfaceallowed, message, reason, trustedDomains
- EditorHostEditorCapabilityinterface$append, $create, $createExtensionDecoratorNode, $createExtensionElementNode, $createExtensionFigureNode, $insert, $isExtensionDecoratorNode, $isExtensionElementNode, $move, ExtensionElementNode, ExtensionRendererNode, externalFrames, TOGGLE_AUDIO_RECORDING_COMMAND, registerElement(), registerExtensionNodeRenderer(), registerSlashCommand(), useChildren(), useNodeState()
- EditorHostModuleApiinterfacedefault, mod
- ExtensionElementCapabilityinterfaceregisterElement()
- ExtensionElementChildHandleinterfacekey, props, type
- ExtensionElementChildPropsinterfacefor
- ExtensionElementChildSchemainterfaceallow, inline, max, min, autofill()
- ExtensionElementDefinitioninterfacechildren, render()
- ExtensionElementRenderContextinterfaceChild, children, Children, nodeKey, props, setProps(), update()
- ExtensionNodeRendererCapabilityinterfaceregisterExtensionNodeRenderer()
- ExtensionNodeRenderPropsinterfacenodeKey, props, type
- ExtensionSlashCommandinterfaceid, keywords, title, run()
- ExtensionSlashCommandCapabilityinterfaceregisterSlashCommand()
- ExtensionSlashCommandRunContextinterfaceeditor, query
- ExtensionWidgetCapabilityinterfaceregisterExtensionWidget()
- ModularEditorHostApiinterfacecontext, editor, ui
- HostContextinterfaceThe context for code the host runs inside the renderer itself: editor extensions, canvas elements, and React UI reached through `useMod()`. It carries the same capabilities as a view minus the panel.
- OwnedStateinterfaceA writable handle to state your own mod declared. Returned by `ctx.state(declaration)` when you pass the value you built with state.
- StateinterfaceA read-only handle to one state value. Returned by `ctx.state('editor.selection')` and the other built-in state names.
- StateSnapshotinterfaceaccessScope, capturedAt, descriptor, id, kind, previous, revision, value
Types7
- EditorExternalFrameDeniedReasontype'empty-src' | 'invalid-src' | 'unsupported-scheme' | 'untrusted-domain'
- EditorExternalFrameTrustResulttypeEditorExternalFrameAllowedResult | EditorExternalFrameDeniedResult
- EditorHostUiCapabilitytypeExtensionWidgetCapability
- ExtensionElementChildComponenttypeComponentType<ExtensionElementChildProps>
- ExtensionElementChildrenComponenttypeComponentType
- ExtensionNodeRenderertypeComponentType<ExtensionNodeRenderProps>
- ExtensionWidgetRenderertype() => ReactNode