Documentation / @ripl/vue / RiplElementPropsOptions

Interface: RiplElementPropsOptions<TElement>

Defined in: adapters/vue/src/core/use-element-props.ts:27

How a component builds its element from props and writes later changes back onto it.

Type Parameters

Type Parameter
TElement extends Element

Properties

Property	Type	Description	Defined in
constructionOnlyKeys?	ReadonlySet<string>	Which are read only at construction. Defaults to the shared element set.	adapters/vue/src/core/use-element-props.ts:33
keys	readonly string[]	Every prop name the component declares.	adapters/vue/src/core/use-element-props.ts:29
paintedKeys?	ReadonlySet<string>	Which plain fields change how the element paints, so a repaint has to be requested. Defaults to the shape fields.	adapters/vue/src/core/use-element-props.ts:35
stateKeys	ReadonlySet<string>	Which of those names are animatable state rather than plain fields.	adapters/vue/src/core/use-element-props.ts:31

Methods

apply()

apply(element, partition): void

Defined in: adapters/vue/src/core/use-element-props.ts:39

Writes a batch of changed props onto the element.

Parameters

Parameter	Type
element	TElement
partition	RiplPropPartition

Returns

void

---

create()

create(initial): TElement | undefined

Defined in: adapters/vue/src/core/use-element-props.ts:37

Builds the element from the construction snapshot, or returns undefined to decline.

Parameters

Parameter	Type
initial	RiplWritable

Returns

TElement | undefined