Documentation / @ripl/vue / RiplContextProps
Interface: RiplContextProps ​
Defined in: adapters/vue/src/components/context.ts:74
Props accepted by RiplContext.
Extends ​
Properties ​
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
context? | Context<Element, Record<string, unknown>> | An existing context to draw into instead of creating one. Use this to render through a backend other than canvas, or to keep a context alive across re-mounts. | - | adapters/vue/src/components/context.ts:79 |
dragThreshold? | number | Minimum pointer movement, in pixels, before a drag gesture is recognised. Defaults to 3. | - | adapters/vue/src/components/context.ts:83 |
interactive? | boolean | Whether the context listens for and emits pointer and drag events. Defaults to true. | - | adapters/vue/src/components/context.ts:81 |
meta? | Record<string, unknown> | Arbitrary metadata attached to the context. | - | adapters/vue/src/components/context.ts:85 |
onClick? | RiplListener<RiplPointerPayload> | Fired when the pointer is pressed and released without an intervening drag. | RiplPointerListeners.onClick | adapters/vue/src/types.ts:54 |
onDrag? | RiplListener<RiplDragPayload> | Fired on each pointer move during a drag gesture. | RiplPointerListeners.onDrag | adapters/vue/src/types.ts:68 |
onDragend? | RiplListener<RiplDragPayload> | Fired when a drag gesture ends. | RiplPointerListeners.onDragend | adapters/vue/src/types.ts:70 |
onDragstart? | RiplListener<RiplDragPayload> | Fired once the pointer has moved past the drag threshold with the button held. | RiplPointerListeners.onDragstart | adapters/vue/src/types.ts:66 |
onMousedown? | RiplListener<RiplPointerPayload> | Fired when the pointer is pressed down. | RiplPointerListeners.onMousedown | adapters/vue/src/types.ts:56 |
onMouseenter? | RiplListener<null> | Fired when the pointer enters. | RiplPointerListeners.onMouseenter | adapters/vue/src/types.ts:62 |
onMouseleave? | RiplListener<null> | Fired when the pointer leaves. | RiplPointerListeners.onMouseleave | adapters/vue/src/types.ts:64 |
onMousemove? | RiplListener<RiplPointerPayload> | Fired as the pointer moves. | RiplPointerListeners.onMousemove | adapters/vue/src/types.ts:60 |
onMouseup? | RiplListener<RiplPointerPayload> | Fired when the pointer is released. | RiplPointerListeners.onMouseup | adapters/vue/src/types.ts:58 |
onReady? | (context) => void | Fired once the context exists and its host element is in the document. | - | adapters/vue/src/components/context.ts:87 |
onRender? | () => void | Fired when the context requests a repaint that no element change triggered. | - | adapters/vue/src/components/context.ts:91 |
onResize? | () => void | Fired when the context's surface is resized. | - | adapters/vue/src/components/context.ts:89 |