The API reference is a Work in Progress and will be continuously improved and extended. We'd love to hear your feedback in our documentation repository.
Home > @edtr-io/plugin > object
object() function
Signature:export declare function object<Ds extends Record<string, StateType>>(
types: Ds,
getFocusableChildren?: (
children: {
[K in keyof Ds]: {
id: string
}[]
}
) => {
id: string
}[]
): ObjectStateType<Ds>
Parameters
| Parameter | Type | Description |
|---|---|---|
| types | Ds | The state types of the properties of the object |
| getFocusableChildren | (children: { [K in keyof Ds]: { id: string; }[]; }) => { id: string; }[] | Allows to override the default order of focusable children |
ObjectStateType<Ds>
