Documentation / @ripl/vue / RiplSceneProps
Interface: RiplSceneProps ​
Defined in: adapters/vue/src/components/scene.ts:74
Props accepted by RiplScene.
Extends ​
Properties ​
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
class? | unknown | Class names used for querying, in any of Vue's class binding forms. | RiplElementOptionProps.class | adapters/vue/src/types.ts:92 |
data? | unknown | Arbitrary user data bound to the element, typically the datum backing it. | RiplElementOptionProps.data | adapters/vue/src/types.ts:94 |
direction? | Direction | Directionality used when rendering text. | Partial.direction | packages/core/src/context/types.ts:229 |
fill? | string | Fill style (CSS color, gradient, or pattern) used to paint filled regions. | Partial.fill | packages/core/src/context/types.ts:225 |
filter? | string | CSS filter string applied to subsequent drawing operations (e.g. blur(4px)). | Partial.filter | packages/core/src/context/types.ts:227 |
font? | string | CSS font shorthand used when rendering text. | Partial.font | packages/core/src/context/types.ts:231 |
fontKerning? | FontKerning | Whether font kerning is applied when rendering text. | Partial.fontKerning | packages/core/src/context/types.ts:233 |
globalCompositeOperation? | unknown | Compositing operation controlling how new drawing is blended with existing content. | Partial.globalCompositeOperation | packages/core/src/context/types.ts:237 |
id? | string | Stable id used for querying and for matching an element across renders. | RiplElementOptionProps.id | adapters/vue/src/types.ts:90 |
interpolators? | ElementInterpolators<Partial<BaseState>> | Interpolator overrides for individual state properties, layered over the defaults the element type declares. Read once, when the element is constructed. | RiplElementOptionProps.interpolators | adapters/vue/src/types.ts:101 |
lineCap? | LineCap | Cap style drawn at the endpoints of stroked lines. | Partial.lineCap | packages/core/src/context/types.ts:239 |
lineDash? | number[] | Dash pattern as alternating stroke and gap lengths; empty for a solid line. | Partial.lineDash | packages/core/src/context/types.ts:241 |
lineDashOffset? | number | Distance into the line dash pattern at which dashing begins. | Partial.lineDashOffset | packages/core/src/context/types.ts:243 |
lineJoin? | LineJoin | Join style drawn where two stroked segments meet. | Partial.lineJoin | packages/core/src/context/types.ts:245 |
lineWidth? | number | Width, in pixels, of stroked lines. | Partial.lineWidth | packages/core/src/context/types.ts:247 |
miterLimit? | number | Miter length limit ratio applied to miter line joins. | Partial.miterLimit | packages/core/src/context/types.ts:249 |
onAttached? | RiplListener<Group<ElementEventMap>> | Fired when the element is added to a group, with the group it joined. | RiplElementListeners.onAttached | adapters/vue/src/types.ts:80 |
onClick? | RiplListener<RiplPointerPayload> | Fired when the pointer is pressed and released without an intervening drag. | RiplElementListeners.onClick | adapters/vue/src/types.ts:54 |
onDestroyed? | RiplListener<null> | Fired when the element is destroyed. | RiplElementListeners.onDestroyed | adapters/vue/src/types.ts:78 |
onDetached? | RiplListener<Group<ElementEventMap>> | Fired when the element is removed from a group, with the group it left. | RiplElementListeners.onDetached | adapters/vue/src/types.ts:82 |
onDrag? | RiplListener<RiplDragPayload> | Fired on each pointer move during a drag gesture. | RiplElementListeners.onDrag | adapters/vue/src/types.ts:68 |
onDragend? | RiplListener<RiplDragPayload> | Fired when a drag gesture ends. | RiplElementListeners.onDragend | adapters/vue/src/types.ts:70 |
onDragstart? | RiplListener<RiplDragPayload> | Fired once the pointer has moved past the drag threshold with the button held. | RiplElementListeners.onDragstart | adapters/vue/src/types.ts:66 |
onGraph? | RiplListener<null> | Fired when the shape of the scene graph at or below this element changes. | RiplElementListeners.onGraph | adapters/vue/src/types.ts:84 |
onMousedown? | RiplListener<RiplPointerPayload> | Fired when the pointer is pressed down. | RiplElementListeners.onMousedown | adapters/vue/src/types.ts:56 |
onMouseenter? | RiplListener<null> | Fired when the pointer enters. | RiplElementListeners.onMouseenter | adapters/vue/src/types.ts:62 |
onMouseleave? | RiplListener<null> | Fired when the pointer leaves. | RiplElementListeners.onMouseleave | adapters/vue/src/types.ts:64 |
onMousemove? | RiplListener<RiplPointerPayload> | Fired as the pointer moves. | RiplElementListeners.onMousemove | adapters/vue/src/types.ts:60 |
onMouseup? | RiplListener<RiplPointerPayload> | Fired when the pointer is released. | RiplElementListeners.onMouseup | adapters/vue/src/types.ts:58 |
onUpdated? | RiplListener<RiplUpdatedPayload> | Fired whenever one of the element's state properties changes. | RiplElementListeners.onUpdated | adapters/vue/src/types.ts:76 |
opacity? | number | Global alpha applied to everything drawn, from 0 to 1. | Partial.opacity | packages/core/src/context/types.ts:235 |
pointerEvents? | ElementPointerEvents | Which parts of the element respond to pointer hit testing. Defaults to all. | RiplElementOptionProps.pointerEvents | adapters/vue/src/types.ts:96 |
renderOnResize? | boolean | Whether the scene re-renders automatically when its context is resized. Defaults to true. | - | adapters/vue/src/components/scene.ts:76 |
rotation? | Rotation | Rotation applied to the element's transform, as radians or a deg/rad string. | Partial.rotation | packages/core/src/context/types.ts:275 |
shadowBlur? | number | Gaussian blur radius applied to drawn shadows. | Partial.shadowBlur | packages/core/src/context/types.ts:251 |
shadowColor? | string | Color of drawn shadows. | Partial.shadowColor | packages/core/src/context/types.ts:253 |
shadowOffsetX? | number | Horizontal offset, in pixels, of drawn shadows. | Partial.shadowOffsetX | packages/core/src/context/types.ts:255 |
shadowOffsetY? | number | Vertical offset, in pixels, of drawn shadows. | Partial.shadowOffsetY | packages/core/src/context/types.ts:257 |
stroke? | string | Stroke style (CSS color, gradient, or pattern) used to paint outlines. | Partial.stroke | packages/core/src/context/types.ts:259 |
textAlign? | TextAlignment | Horizontal alignment of text relative to the drawing position. | Partial.textAlign | packages/core/src/context/types.ts:261 |
textBaseline? | TextBaseline | Vertical baseline used when positioning text. | Partial.textBaseline | packages/core/src/context/types.ts:263 |
transformOriginX? | TransformOrigin | Horizontal origin about which rotation and scaling are applied. | Partial.transformOriginX | packages/core/src/context/types.ts:277 |
transformOriginY? | TransformOrigin | Vertical origin about which rotation and scaling are applied. | Partial.transformOriginY | packages/core/src/context/types.ts:279 |
transformScaleX? | number | Horizontal scale factor applied to the element's transform. | Partial.transformScaleX | packages/core/src/context/types.ts:271 |
transformScaleY? | number | Vertical scale factor applied to the element's transform. | Partial.transformScaleY | packages/core/src/context/types.ts:273 |
translateX? | number | Horizontal translation, in pixels, applied to the element's transform. | Partial.translateX | packages/core/src/context/types.ts:267 |
translateY? | number | Vertical translation, in pixels, applied to the element's transform. | Partial.translateY | packages/core/src/context/types.ts:269 |
zIndex? | number | Stacking order used to sort elements during rendering; higher values draw on top. | Partial.zIndex | packages/core/src/context/types.ts:265 |