@revideo/2d / components / LayoutProps
Interface: LayoutProps
Defined in: 2d/src/lib/components/Layout.ts:58
Extends
Extended by
Properties
alignContent?
optionalalignContent?:SignalValue<FlexContent>
Defined in: 2d/src/lib/components/Layout.ts:89
alignItems?
optionalalignItems?:SignalValue<FlexItems>
Defined in: 2d/src/lib/components/Layout.ts:90
alignSelf?
optionalalignSelf?:SignalValue<FlexItems>
Defined in: 2d/src/lib/components/Layout.ts:91
basis?
optionalbasis?:SignalValue<FlexBasis>
Defined in: 2d/src/lib/components/Layout.ts:83
bottom?
optionalbottom?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:138
The position of the bottom edge of this node.
Remarks
This shortcut property will set the node’s position so that the bottom edge ends up in the given place. If present, overrides the NodeProps.position property.
bottomLeft?
optionalbottomLeft?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:183
The position of the bottom left corner of this node.
Remarks
This shortcut property will set the node’s position so that the bottom left corner ends up in the given place. If present, overrides the NodeProps.position property.
bottomRight?
optionalbottomRight?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:192
The position of the bottom right corner of this node.
Remarks
This shortcut property will set the node’s position so that the bottom right corner ends up in the given place. If present, overrides the NodeProps.position property.
cache?
optionalcache?:SignalValue<boolean>
Defined in: 2d/src/lib/components/Node.ts:99
Inherited from
cachePadding?
optionalcachePadding?:SignalValue<PossibleSpacing>
Defined in: 2d/src/lib/components/Node.ts:119
Controls the padding of the cached canvas used by this node.
Remarks
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.
Inherited from
cachePaddingBottom?
optionalcachePaddingBottom?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:107
Controls the padding of the cached canvas used by this node.
Remarks
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.
Inherited from
cachePaddingLeft?
optionalcachePaddingLeft?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:111
Controls the padding of the cached canvas used by this node.
Remarks
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.
Inherited from
cachePaddingRight?
optionalcachePaddingRight?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:115
Controls the padding of the cached canvas used by this node.
Remarks
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.
Inherited from
cachePaddingTop?
optionalcachePaddingTop?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:103
Controls the padding of the cached canvas used by this node.
Remarks
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.
Inherited from
children?
optionalchildren?:SignalValue<ComponentChildren>
Defined in: 2d/src/lib/components/Node.ts:71
Inherited from
clip?
optionalclip?:SignalValue<boolean>
Defined in: 2d/src/lib/components/Layout.ts:193
columnGap?
optionalcolumnGap?:SignalValue<Length>
Defined in: 2d/src/lib/components/Layout.ts:93
composite?
optionalcomposite?:SignalValue<boolean>
Defined in: 2d/src/lib/components/Node.ts:121
Inherited from
compositeOperation?
optionalcompositeOperation?:SignalValue<GlobalCompositeOperation>
Defined in: 2d/src/lib/components/Node.ts:122
Inherited from
direction?
optionaldirection?:SignalValue<FlexDirection>
Defined in: 2d/src/lib/components/Layout.ts:82
filters?
optionalfilters?:SignalValue<Filter[]>
Defined in: 2d/src/lib/components/Node.ts:91
Inherited from
fontFamily?
optionalfontFamily?:SignalValue<string>
Defined in: 2d/src/lib/components/Layout.ts:96
fontSize?
optionalfontSize?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:97
fontStyle?
optionalfontStyle?:SignalValue<string>
Defined in: 2d/src/lib/components/Layout.ts:98
fontWeight?
optionalfontWeight?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:99
gap?
optionalgap?:SignalValue<Length>
Defined in: 2d/src/lib/components/Layout.ts:94
grow?
optionalgrow?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:84
height?
optionalheight?:SignalValue<Length>
Defined in: 2d/src/lib/components/Layout.ts:63
justifyContent?
optionaljustifyContent?:SignalValue<FlexContent>
Defined in: 2d/src/lib/components/Layout.ts:88
key?
optionalkey?:string
Defined in: 2d/src/lib/components/Node.ts:76
Inherited from
layout?
optionallayout?:LayoutMode
Defined in: 2d/src/lib/components/Layout.ts:59
left?
optionalleft?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:147
The position of the left edge of this node.
Remarks
This shortcut property will set the node’s position so that the left edge ends up in the given place. If present, overrides the NodeProps.position property.
letterSpacing?
optionalletterSpacing?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:101
lineHeight?
optionallineHeight?:SignalValue<Length>
Defined in: 2d/src/lib/components/Layout.ts:100
margin?
optionalmargin?:SignalValue<PossibleSpacing>
Defined in: 2d/src/lib/components/Layout.ts:74
marginBottom?
optionalmarginBottom?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:71
marginLeft?
optionalmarginLeft?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:72
marginRight?
optionalmarginRight?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:73
marginTop?
optionalmarginTop?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:70
maxHeight?
optionalmaxHeight?:SignalValue<LengthLimit>
Defined in: 2d/src/lib/components/Layout.ts:65
maxWidth?
optionalmaxWidth?:SignalValue<LengthLimit>
Defined in: 2d/src/lib/components/Layout.ts:64
middle?
optionalmiddle?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:120
The position of the center of this node.
Remarks
This shortcut property will set the node’s position so that the center ends up in the given place. If present, overrides the NodeProps.position property. When offset is not set, this will be the same as the NodeProps.position.
minHeight?
optionalminHeight?:SignalValue<LengthLimit>
Defined in: 2d/src/lib/components/Layout.ts:67
minWidth?
optionalminWidth?:SignalValue<LengthLimit>
Defined in: 2d/src/lib/components/Layout.ts:66
offset?
optionaloffset?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:109
offsetX?
optionaloffsetX?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:107
offsetY?
optionaloffsetY?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:108
opacity?
optionalopacity?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:90
Inherited from
padding?
optionalpadding?:SignalValue<PossibleSpacing>
Defined in: 2d/src/lib/components/Layout.ts:80
paddingBottom?
optionalpaddingBottom?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:77
paddingLeft?
optionalpaddingLeft?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:78
paddingRight?
optionalpaddingRight?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:79
paddingTop?
optionalpaddingTop?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:76
position?
optionalposition?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Node.ts:80
Inherited from
ratio?
optionalratio?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:68
ref?
optionalref?:ReferenceReceiver<any>
Defined in: 2d/src/lib/components/Node.ts:70
Inherited from
right?
optionalright?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:156
The position of the right edge of this node.
Remarks
This shortcut property will set the node’s position so that the right edge ends up in the given place. If present, overrides the NodeProps.position property.
rotation?
optionalrotation?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:81
Inherited from
rowGap?
optionalrowGap?:SignalValue<Length>
Defined in: 2d/src/lib/components/Layout.ts:92
scale?
optionalscale?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Node.ts:84
Inherited from
scaleX?
optionalscaleX?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:82
Inherited from
scaleY?
optionalscaleY?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:83
Inherited from
shaders?
optionalshaders?:PossibleShaderConfig
Defined in: 2d/src/lib/components/Node.ts:126
Experimental
Inherited from
shadowBlur?
optionalshadowBlur?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:94
Inherited from
shadowColor?
optionalshadowColor?:SignalValue<PossibleColor>
Defined in: 2d/src/lib/components/Node.ts:93
Inherited from
shadowOffset?
optionalshadowOffset?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Node.ts:97
Inherited from
shadowOffsetX?
optionalshadowOffsetX?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:95
Inherited from
shadowOffsetY?
optionalshadowOffsetY?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:96
Inherited from
shrink?
optionalshrink?:SignalValue<number>
Defined in: 2d/src/lib/components/Layout.ts:85
size?
optionalsize?:SignalValue<PossibleVector2<Length>>
Defined in: 2d/src/lib/components/Layout.ts:106
skew?
optionalskew?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Node.ts:87
Inherited from
skewX?
optionalskewX?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:85
Inherited from
skewY?
optionalskewY?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:86
Inherited from
spawner?
optionalspawner?:SignalValue<ComponentChildren>
Defined in: 2d/src/lib/components/Node.ts:75
Deprecated
Use children instead.
Inherited from
tagName?
optionaltagName?: keyof HTMLElementTagNameMap
Defined in: 2d/src/lib/components/Layout.ts:60
textAlign?
optionaltextAlign?:SignalValue<CanvasTextAlign>
Defined in: 2d/src/lib/components/Layout.ts:104
textDirection?
optionaltextDirection?:SignalValue<CanvasDirection>
Defined in: 2d/src/lib/components/Layout.ts:103
textWrap?
optionaltextWrap?:SignalValue<TextWrap>
Defined in: 2d/src/lib/components/Layout.ts:102
top?
optionaltop?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:129
The position of the top edge of this node.
Remarks
This shortcut property will set the node’s position so that the top edge ends up in the given place. If present, overrides the NodeProps.position property.
topLeft?
optionaltopLeft?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:165
The position of the top left corner of this node.
Remarks
This shortcut property will set the node’s position so that the top left corner ends up in the given place. If present, overrides the NodeProps.position property.
topRight?
optionaltopRight?:SignalValue<PossibleVector2>
Defined in: 2d/src/lib/components/Layout.ts:174
The position of the top right corner of this node.
Remarks
This shortcut property will set the node’s position so that the top right corner ends up in the given place. If present, overrides the NodeProps.position property.
width?
optionalwidth?:SignalValue<Length>
Defined in: 2d/src/lib/components/Layout.ts:62
wrap?
optionalwrap?:SignalValue<FlexWrap>
Defined in: 2d/src/lib/components/Layout.ts:86
x?
optionalx?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:78
Inherited from
y?
optionaly?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:79
Inherited from
zIndex?
optionalzIndex?:SignalValue<number>
Defined in: 2d/src/lib/components/Node.ts:88