Code
class Code extends Shape
A node for displaying and animating code.
import ...
export default makeScene2D(function* (view) {
LezerHighlighter.registerParser(parser);
const code = createRef<Code>();
view.add(
<Code
ref={code}
offset={-1}
position={view.size().scale(-0.5).add(60)}
fontFamily={'JetBrains Mono, monospace'}
fontSize={36}
code={`\
function hello() {
console.log('Hello');
}`}
/>,
);
yield* code()
.code(
`\
function hello() {
console.warn('Hello World');
}`,
1,
)
.wait(0.5)
.back(1)
.wait(0.5);
});
Constructors
constructor
Parameters
OverwritesShape.constructorProperties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalCode
A helper signal for operating on the position in world space.
Retrieving the position using this signal returns the position in world space. Similarly, setting the position using this signal transforms the new value to local space.
If the new value is a function, the position of this node will be continuously updated to always match the position returned by the function. This can be useful to "pin" the node in a specific place or to make it follow another node's position.
Unlike position, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Shape.absolutePositionabsoluteRotation
readonly public absoluteRotation: SimpleSignalnumberCode
A helper signal for operating on the rotation in world space.
Retrieving the rotation using this signal returns the rotation in world space. Similarly, setting the rotation using this signal transforms the new value to local space.
If the new value is a function, the rotation of this node will be continuously updated to always match the rotation returned by the function.
Inherited fromShape.absoluteRotationabsoluteScale
readonly public absoluteScale: SimpleVector2SignalCode
A helper signal for operating on the scale in world space.
Retrieving the scale using this signal returns the scale in world space. Similarly, setting the scale using this signal transforms the new value to local space.
If the new value is a function, the scale of this node will be continuously updated to always match the position returned by the function.
Unlike scale, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Shape.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentCode
Shape.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsCode
Shape.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsCode
Shape.alignSelfantialiased
readonly public antialiased: SimpleSignalbooleanCode
Shape.antialiasedbasis
readonly public basis: SimpleSignalFlexBasisCode
Shape.basisbottom
readonly public bottom: SimpleVector2SignalCode
The position of the bottom edge of this node.
When set, this shortcut property will modify the node's position so that the bottom edge ends up in the given place.
When retrieved, it will return the position of the bottom edge in the parent space.
Inherited fromShape.bottombottomLeft
readonly public bottomLeft: SimpleVector2SignalCode
The position of the bottom left corner of this node.
When set, this shortcut property will modify the node's position so that the bottom left corner ends up in the given place.
When retrieved, it will return the position of the bottom left corner in the parent space.
Inherited fromShape.bottomLeftbottomRight
readonly public bottomRight: SimpleVector2SignalCode
The position of the bottom right corner of this node.
When set, this shortcut property will modify the node's position so that the bottom right corner ends up in the given place.
When retrieved, it will return the position of the bottom right corner in the parent space.
Inherited fromShape.bottomRightcache
readonly public cache: SimpleSignalbooleanCode
Shape.cachecachePadding
readonly public cachePadding: SpacingSignalCode
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
Shape.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]CodeSignalContextComponentChildrenNode[]Code
Shape.childrenclip
readonly public clip: SimpleSignalbooleanCode
Shape.clipcode
readonly public code: CodeSignalCode
The code to display.
composite
readonly public composite: SimpleSignalbooleanCode
Shape.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationCode
Shape.compositeOperationcreationStack
readonly public creationStack?: string
Shape.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionCode
Shape.directiondrawHooks
readonly public drawHooks: SimpleSignalDrawHooksCode
Custom drawing logic for the code.
Check out DrawHooks for available render hooks.
Examples
element
public element: HTMLElement
Shape.elementfill
readonly public fill: CanvasStyleSignalCode
Shape.fillfilters
readonly public filters: FiltersSignalCode
Shape.filtersfontFamily
readonly public fontFamily: SimpleSignalstringCode
Shape.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberCode
Shape.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringCode
Shape.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberCode
Shape.fontWeightgap
readonly public gap: Vector2LengthSignalCode
Shape.gapgrow
readonly public grow: SimpleSignalnumberCode
Shape.growhighlighter
readonly public highlighter: SimpleSignalnullCodeHighlighterunknownCode
The code highlighter to use for this code node.
Defaults to a shared LezerHighlighter.
isClass
public isClass: boolean
Shape.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentCode
Shape.justifyContentkey
readonly public key: string
Shape.keylayout
readonly public layout: SimpleSignalLayoutModeCode
Shape.layoutleft
readonly public left: SimpleVector2SignalCode
The position of the left edge of this node.
When set, this shortcut property will modify the node's position so that the left edge ends up in the given place.
When retrieved, it will return the position of the left edge in the parent space.
Inherited fromShape.leftletterSpacing
readonly public letterSpacing: SimpleSignalnumberCode
Shape.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapCode
Shape.lineCaplineDash
readonly public lineDash: SimpleSignalnumber[]Code
Shape.lineDashlineDashOffset
readonly public lineDashOffset: SimpleSignalnumberCode
Shape.lineDashOffsetlineHeight
readonly public lineHeight: SimpleSignalLengthCode
Shape.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinCode
Shape.lineJoinlineWidth
readonly public lineWidth: SimpleSignalnumberCode
Shape.lineWidthmargin
readonly public margin: SpacingSignalCode
Shape.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitCode
Shape.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitCode
Shape.maxWidthmiddle
readonly public middle: SimpleVector2SignalCode
The position of the center of this node.
When set, this shortcut property will modify the node's position so that the center ends up in the given place.
If the offset has not been changed, this will be the same as the
position.
When retrieved, it will return the position of the center in the parent space.
Inherited fromShape.middleminHeight
readonly public minHeight: SimpleSignalLengthLimitCode
Shape.minHeightminWidth
readonly public minWidth: SimpleSignalLengthLimitCode
Shape.minWidthoffset
readonly public offset: Vector2SignalCode
Represents the offset of this node's origin.
By default, the origin of a node is located at its center. The origin serves as the pivot point when rotating and scaling a node, but it doesn't affect the placement of its children.
The value is relative to the size of this node. A value of 1 means as far
to the right/bottom as possible. Here are a few examples of offsets:
[-1, -1]- top left corner[1, -1]- top right corner[0, 1]- bottom edge[-1, 1]- bottom left corner
Shape.offsetoldSelection
public oldSelection: nullCodeSelection = null
opacity
readonly public opacity: SimpleSignalnumberCode
Represents the opacity of this node in the range 0-1.
The value is clamped to the range 0-1.
Inherited fromShape.opacitypadding
readonly public padding: SpacingSignalCode
Shape.paddingparent
readonly public parent: SimpleSignalnullNodevoid = ...
Shape.parentposition
readonly public position: Vector2SignalCode
Represents the position of this node in local space of its parent.
Examples
Inherited fromShape.positionproperties
readonly public properties: RecordstringPropertyMetadataany = ...
Shape.propertiesratio
readonly public ratio: SimpleSignalnullnumberCode
Shape.ratioright
readonly public right: SimpleVector2SignalCode
The position of the right edge of this node.
When set, this shortcut property will modify the node's position so that the right edge ends up in the given place.
When retrieved, it will return the position of the right edge in the parent space.
Inherited fromShape.rightrotation
readonly public rotation: SimpleSignalnumberCode
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromShape.rotationscale
readonly public scale: Vector2SignalCode
Represents the scale of this node in local space of its parent.
Examples
Inherited fromShape.scaleselection
The currently selected code range.
Either a single CodeRange or an array of them
describing which parts of the code should be visually emphasized.
You can use word and
lines to quickly create ranges.
Examples
selectionProgress
public selectionProgress: SimpleSignalnullnumbervoid = ...
shaders
readonly public shaders: SignalPossibleShaderConfigShaderConfig[]CodeSignalContextPossibleShaderConfigShaderConfig[]Code
Shape.shadersshadowBlur
readonly public shadowBlur: SimpleSignalnumberCode
Shape.shadowBlurshadowColor
readonly public shadowColor: ColorSignalCode
Shape.shadowColorshadowOffset
readonly public shadowOffset: Vector2SignalCode
Shape.shadowOffsetshrink
readonly public shrink: SimpleSignalnumberCode
Shape.shrinksize
readonly public size: Vector2LengthSignalCode
Represents the size of this node.
A size is a two-dimensional vector, where x represents the width, and y
represents the height.
The value of both x and y is of type Length which is
either:
number- the desired length in pixels${number}%- a string with the desired length in percents, for example'50%'null- an automatic length
When retrieving the size, all units are converted to pixels, using the
current state of the layout. For example, retrieving the width set to
'50%', while the parent has a width of 200px will result in the number
100 being returned.
When the node is not part of the layout, setting its size using percents refers to the size of the entire scene.
Examples
Inherited fromShape.sizeskew
readonly public skew: Vector2SignalCode
Represents the skew of this node in local space of its parent.
Examples
Inherited fromShape.skewstroke
readonly public stroke: CanvasStyleSignalCode
Shape.strokestrokeFirst
readonly public strokeFirst: SimpleSignalbooleanCode
Shape.strokeFirststyles
public styles: CSSStyleDeclaration
Shape.stylestextAlign
readonly public textAlign: SimpleSignalCanvasTextAlignCode
Shape.textAligntextDirection
readonly public textDirection: SimpleSignalCanvasDirectionCode
Shape.textDirectiontextWrap
readonly public textWrap: SimpleSignalTextWrapCode
Shape.textWraptop
readonly public top: SimpleVector2SignalCode
The position of the top edge of this node.
When set, this shortcut property will modify the node's position so that the top edge ends up in the given place.
When retrieved, it will return the position of the top edge in the parent space.
Inherited fromShape.toptopLeft
readonly public topLeft: SimpleVector2SignalCode
The position of the top left corner of this node.
When set, this shortcut property will modify the node's position so that the top left corner ends up in the given place.
When retrieved, it will return the position of the top left corner in the parent space.
Inherited fromShape.topLefttopRight
readonly public topRight: SimpleVector2SignalCode
The position of the top right corner of this node.
When set, this shortcut property will modify the node's position so that the top right corner ends up in the given place.
When retrieved, it will return the position of the top right corner in the parent space.
Inherited fromShape.topRightwrap
readonly public wrap: SimpleSignalFlexWrapCode
Shape.wrapzIndex
readonly public zIndex: SimpleSignalnumberCode
Shape.zIndexdefaultHighlighter
static public defaultHighlighter: nullCodeHighlighterunknown = null
Accessors
columnGap
public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.columnGapheight
public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.heightrowGap
public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.rowGapwidth
public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.widthx
public get x(): SimpleSignalnumberthis
Shape.xy
public get y(): SimpleSignalnumberthis
Shape.yMethods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Shape.[iterator]absoluteOpacity
public absoluteOpacity(): number
Shape.absoluteOpacityadd
public addnode: ComponentChildren: Code
Add the given node(s) as the children of this node.
The nodes will be appended at the end of the children list.
Examples
Parameters
node: ComponentChildrenA node or an array of nodes to append.
Shape.addanchorPosition
public anchorPosition(): Vector2
Shape.anchorPositionapplyState
public applyStatestate: NodeStateduration: numbertiming?: TimingFunction: ThreadGenerator
Apply the given state to the node, setting all matching signal values to the provided values.
Parameters
Inherited fromShape.applyStatecacheBBox
public cacheBBox(): BBox
Get a bounding box for the contents rendered by this node as well as its children.
Inherited fromShape.cacheBBoxchildAs
Get the nth children cast to the specified type.
Type Parameters
Parameters
index: numberThe index of the child to retrieve.
Shape.childAschildrenAs
Get the children array cast to the specified type.
Type Parameters
Inherited fromShape.childrenAsclone
public clonecustomProps: NodeState = {}: Code
Create a copy of this node.
Parameters
customProps: NodeState = {}Properties to override.
Shape.clonecompositeToLocal
public compositeToLocal(): DOMMatrix
Shape.compositeToLocalcompositeToWorld
public compositeToWorld(): DOMMatrix
A matrix mapping composite space to world space.
Certain effects such as blur and shadows ignore the current transformation. This matrix can be used to transform their parameters so that the effect appears relative to the closest composite root.
Inherited fromShape.compositeToWorldcomputedPosition
public computedPosition(): Vector2
Shape.computedPositioncreateSignal
public createSignalinitial: PossibleCodeScope: CodeSignalCode
Create a child code signal.
Parameters
initial: PossibleCodeScopeThe initial code.
dispose
public dispose(): void
Prepare this node to be disposed of.
This method is called automatically when a scene is refreshed. It will be called even if the node is not currently attached to the tree.
The goal of this method is to clean any external references to allow the node to be garbage collected.
Inherited fromShape.disposedrawOverlay
public drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void
Draw an overlay for this node.
The overlay for the currently inspected node is displayed on top of the canvas.
The provided context is in screen space. The local-to-screen matrix can be used to transform all shapes that need to be displayed. This approach allows to keep the line widths and gizmo sizes consistent, no matter how zoomed-in the view is.
Parameters
context: CanvasRenderingContext2DThe context to draw with.
matrix: DOMMatrixA local-to-screen matrix.
Shape.drawOverlayfindAll
Find all descendants of this node that match the given predicate.
Type Parameters
Parameters
Inherited fromShape.findAllfindAllRanges
Find all code ranges that match the given pattern.
Parameters
findAncestor
Find the closest ancestor of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromShape.findAncestorfindFirst
Find the first descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromShape.findFirstfindFirstRange
Find the first code range that matches the given pattern.
Parameters
findLast
Find the last descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromShape.findLastfindLastRange
Find the last code range that matches the given pattern.
Parameters
getOriginDelta
Parameters
Inherited fromShape.getOriginDeltagetPointBbox
Return the bounding box of the given point (character) in the code.
The returned bound box is in local space of the Code node.
Parameters
getSelectionBbox
public getSelectionBboxselection: PossibleCodeSelection: BBox[]
Return bounding boxes of all characters in the selection.
The returned bound boxes are in local space of the Code node.
Each line of code has a separate bounding box.
Parameters
selection: PossibleCodeSelectionThe selection to get the bounding boxes for.
getState
public getState(): NodeState
Return a snapshot of the node's current signal values.
This method will calculate the values of any reactive properties of the node at the time the method is called.
Inherited fromShape.getStatehighlighterCache
public highlighterCache(): nullafter: unknown = ...before: unknown = ...
hit
Try to find a node intersecting the given position.
Parameters
Inherited fromShape.hitinsert
public insertnode: ComponentChildrenindex: number = 0: Code
Insert the given node(s) at the specified index in the children list.
Examples
Parameters
node: ComponentChildrenA node or an array of nodes to insert.
index: number = 0An index at which to insert the node(s).
Shape.insertinstantiate
Create an instance of this node's class.
Parameters
Inherited fromShape.instantiateisLayoutRoot
public isLayoutRoot(): boolean
Shape.isLayoutRootlayoutEnabled
public layoutEnabled(): boolean
Get the resolved layout mode of this node.
When the mode is null, its value will be inherited from the parent.
Use layout to get the raw mode set for this node (without
inheritance).
Shape.layoutEnabledlocalToParent
public localToParent(): DOMMatrix
Get the local-to-parent matrix for this node.
This matrix transforms vectors from local space of this node to local space of this node's parent.
Inherited fromShape.localToParentlocalToWorld
public localToWorld(): DOMMatrix
Get the local-to-world matrix for this node.
This matrix transforms vectors from local space of this node to world space.
Examples
Inherited fromShape.localToWorldlockSize
public lockSize(): void
Shape.lockSizemove
Rearrange this node in relation to its siblings.
Children are rendered starting from the beginning of the children list. We can change the rendering order by rearranging said list.
A positive by arguments move the node up (it will be rendered on top of
the elements it has passed). Negative values move it down.
Parameters
by: number = 1Number of places by which the node should be moved.
Shape.movemoveAbove
public moveAbovenode: NodedirectlyAbove: boolean = false: Code
Move the node above the provided node in the parent's layout.
The node will be moved above the provided node and from then on will be rendered on top of it. By default, if the node is already positioned higher than the sibling node, it will not get moved.
Parameters
node: NodeThe sibling node below which to move.
directlyAbove: boolean = falseWhether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.
Shape.moveAbovemoveBelow
public moveBelownode: NodedirectlyBelow: boolean = false: Code
Move the node below the provided node in the parent's layout.
The node will be moved below the provided node and from then on will be rendered below it. By default, if the node is already positioned lower than the sibling node, it will not get moved.
Parameters
node: NodeThe sibling node below which to move.
directlyBelow: boolean = falseWhether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.
Shape.moveBelowmoveDown
public moveDown(): Code
Move the node down in relation to its siblings.
The node will exchange places with the sibling right below it (if any) and from then on will be rendered under it.
Inherited fromShape.moveDownmoveOffset
Update the offset of this node and adjust the position to keep it in the same place.
Parameters
Inherited fromShape.moveOffsetmoveTo
Move the node to the provided position relative to its siblings.
If the node is getting moved to a lower position, it will be placed below the sibling that's currently at the provided index (if any). If the node is getting moved to a higher position, it will be placed above the sibling that's currently at the provided index (if any).
Parameters
index: numberThe index to move the node to.
Shape.moveTomoveToBottom
public moveToBottom(): Code
Move the node to the bottom in relation to its siblings.
The node will be placed at the beginning of the children list and from then on will be rendered below all of its siblings.
Inherited fromShape.moveToBottommoveToTop
public moveToTop(): Code
Move the node to the top in relation to its siblings.
The node will be placed at the end of the children list and from then on will be rendered on top of all of its siblings.
Inherited fromShape.moveToTopmoveUp
public moveUp(): Code
Move the node up in relation to its siblings.
The node will exchange places with the sibling right above it (if any) and from then on will be rendered on top of it.
Inherited fromShape.moveUpparentAs
Get the parent cast to the specified type.
Type Parameters
Inherited fromShape.parentAsparsed
public parsed(): string
Get the currently displayed code as a string.
peekChildren
public peekChildren(): readonly Node[]
Get the current children of this node.
Unlike children, this method does not have any side effects.
It does not register the children signal as a dependency, and it does not
spawn any children. It can be used to safely retrieve the current state of
the scene graph for debugging purposes.
Shape.peekChildrenreactiveClone
public reactiveClonecustomProps: NodeState = {}: Code
Create a reactive copy of this node.
A reactive copy has all its properties dynamically updated to match the source node.
Parameters
customProps: NodeState = {}Properties to override.
Shape.reactiveClonereleaseSize
public releaseSize(): void
Shape.releaseSizeremove
public remove(): Code
Remove this node from the tree.
Inherited fromShape.removeremoveChildren
public removeChildren(): void
Remove all children of this node.
Inherited fromShape.removeChildrenrender
public rendercontext: CanvasRenderingContext2D: Promisevoid
Render this node onto the given canvas.
Parameters
context: CanvasRenderingContext2DThe context to draw with.
Shape.renderreparent
Change the parent of this node while keeping the absolute transform.
After performing this operation, the node will stay in the same place visually, but its parent will be changed.
Parameters
Inherited fromShape.reparentrestore
public restore(): void
public restoreduration: numbertiming?: TimingFunction: ThreadGenerator
Restore the node to its last saved state.
This method can be used together with the save method to restore a
node to a previously saved state. Restoring a node to a previous state
removes that state from the state stack.
Examples
Inherited fromShape.restoreripple
public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany
Parameters
duration: number = 1
Shape.ripplesave
public save(): void
Push a snapshot of the node's current state onto the node's state stack.
This method can be used together with the restore method to save a
node's current state and later restore it. It is possible to store more
than one state by calling save method multiple times.
Shape.savesnapshotClone
public snapshotClonecustomProps: NodeState = {}: Code
Create a copy of this node.
Unlike clone, a snapshot clone calculates any reactive properties
at the moment of cloning and passes the raw values to the copy.
Parameters
customProps: NodeState = {}Properties to override.
Shape.snapshotClonetoPromise
Wait for any asynchronous resources that this node or its children have.
Certain resources like images are always loaded asynchronously. Awaiting this method makes sure that all such resources are done loading before continuing the animation.
Inherited fromShape.toPromiseview
public view(): View2D
Shape.viewworldToLocal
public worldToLocal(): DOMMatrix
Get the world-to-local matrix for this node.
This matrix transforms vectors from world space to local space of this node.
Examples
Inherited fromShape.worldToLocalworldToParent
public worldToParent(): DOMMatrix
Get the world-to-parent matrix for this node.
This matrix transforms vectors from world space to local space of this node's parent.
Inherited fromShape.worldToParentcreateSignal
static public createSignalinitial: PossibleCodeScopehighlighter?: SignalValueCodeHighlighterunknown: CodeSignalvoid
Create a standalone code signal.
Parameters
initial: PossibleCodeScopeThe initial code.
highlighter?: SignalValueCodeHighlighterunknownCustom highlighter to use.