Builder
<Builder />#
Use 🔧#
A React Component to provide Builder Context. It is a wrapper for your site builder. Every Component and hook Build UI provides must be under this Builder Context.
Props ⚙️#
initialTree?: Tree | Object
The initial tree representation that will be used as the builder state.
note
Make sure you pass a valid tree or valid tree representation object. There will be no sanity check, so passing an invalid tree representation will lead to unexpected behavior.
initialTimeline?: [Object]
The initial timeline that will be used. A timeline contains redo/undo state.
note
Make sure you pass a valid timeline array. There will be no sanity check, so passing an invalid timeline will lead to unexpected behavior.
initialVersion?: int
The initial version, which represents the position of initialTree in initialTime.
note
Make sure you supply the correct version, i.e. redoes/undoes can be applied to tree given initialTimeline elements.
initialHistoryLimit?: int
The maximum amount of undoes/redoes that can be done. You should pass a very large number if you want the history have no limit.
info
Default value for historyBatchTime is 9999999. You can use this prop if you want history state to not grow too large.
initialBatchTime?: int
The amount of time in milliseconds that the batcher timer should wait for the next time batched action before committing to history. (See this for an explanation).
info
Default value for historyBatchTime is 3000
initialBatchTimeLimit?: int
The maximum amount of time in milliseconds that a batch can last for time batched actions (See this for an explanation). Ideally, it should be a multiple of historyBatchTime. It should also be greater than historyBatchTime.
info
Default value for historyBatchTimeLimit is 6000
children?: React.Children
React Children that will be provided with the builder state through context.