@modular/sdk/canvas
46 exports in 4 groups.
Interfaces20
- CameraMoveinterfaceduration, easing, padding
- CanvasBoundsinterfaceheight, width, x, y
- CanvasCamerainterfacex, y, zoom
- CanvasCameraControllerinterfacecurrent, locked, ready, canvasToScreen(), lookAt(), screenToCanvas(), setCamera(), setLocked()
- CanvasDrawContextinterfacecolor, event, overlay, regionId, size, screenToFlowPosition()
- CanvasDrawOverlayinterfacecanvas, clear(), drawArrow(), drawStroke()
- CanvasDrawToolinterfacecursor, id, cancel(), onPointerDown(), onPointerMove(), onPointerUp()
- CanvasElementContributioninterfaceschema, tool, view
- CanvasElementDataFieldinterfaceattr, defaultValue, key, kind
- CanvasElementSchemainterfaceattrs, dataAttrs, mintName, rfType, structure, tag, toData, write
- CanvasPointinterfacex, y
- DocumentCanvasHostCanvasCapabilityinterfaceregisterElement(), useCamera(), useElementState()
- DocumentCanvasHostModuleApiinterfacedefault, mod
- DocumentModularCanvasHostApiinterfacecanvas, context
- LeafCanvasElementSchemaOptionsinterfacefields, mintName, rfType, tag
- NewElementinterfaceattrs, tag
- 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
Types14
- AttrKindtype'string' | 'number' | 'boolean' | 'json' | 'handles' | 'endpoints' | 'shape' | 'edgeType' | 'marker' | 'points' | 'arrowhead'
- AttrValuetypeJsonValue | readonly HandleSpec[] | readonly Endpoint[]
- CameraFocustypeCanvasBounds | string | readonly string[]
- CanvasArrowheadtype'arrow' | 'triangle' | 'bar' | 'circle' | 'diamond'
- CanvasArrowPointtype[number, number]
- CanvasElementDataFieldKindtype'string' | 'number' | 'boolean' | 'arrowhead'
- CanvasElementDataFieldValuetypeTKind extends 'number' ? number : TKind extends 'boolean' ? boolean : string
- CanvasElementDataFromFieldstype{ readonly [TField in TFields[number] as TField['key']]: CanvasElementDataFieldValue<TField['kind']> } & Record<string, unknown>
- CanvasElementRenderPropstypeNodeProps<TData>
- CanvasElementStateSettertype(next: Readonly<Record<string, unknown>>) => void
- CanvasStrokePointtype[number, number, number]
- ElementStructuralClasstype'leaf' | 'content' | 'container' | 'edge' | 'framed'
- JsonValuetypenull | boolean | number | string | readonly JsonValue[] | {}
- RegisteredCanvasElementTagtype`${string}-${string}`
Functions6
- defineCanvasElementfunction<TData extends Record<string, unknown>>(contribution: CanvasElementContribution<TData>) => CanvasElementContribution<TData>
- defineCanvasElementDataFieldsfunction<TFields extends readonly CanvasElementDataField<string, CanvasElementDataFieldKind>[]>(fields: TFields) => TFields
- defineLeafCanvasElementSchemafunction<K extends `${string}-${string}`, TFields extends readonly CanvasElementDataField<string, CanvasElementDataFieldKind>[]>(options: LeafCanvasElementSchemaOptions<K, TFields>) => CanvasElementSchema<CanvasElementDataFromFields<TFields>, K>
- useNodeIdfunction() => string | null
- useUpdateNodeInternalsfunction() => (id: string) => void
- useModStatefunction<TValue>(state: State<TValue>) => StateSnapshot<TValue>
Values6
- CanvasCameraErrorconst{ badFocus: 'CanvasCameraBadFocus'; notReady: 'CanvasCameraNotReady' }
- HandleconstComponentType<HandleProps>
- modconstDocumentModularCanvasHostApi
- NodeResizerconstComponentType<NodeResizerProps>
- PanelconstComponentType<PanelProps>
- Positionconst{ Bottom: 'bottom'; Left: 'left'; Right: 'right'; Top: 'top' }