TinyBase logoTinyBase β

CheckpointProps

CheckpointProps props are used for components that refer to a single checkpoint in a Checkpoints object, such as the CheckpointView component.

{
  checkpointId: Id;
  checkpoints?: CheckpointsOrCheckpointsId;
  debugIds?: boolean;
}
TypeDescription
checkpointIdId

The Id of the checkpoint in the Checkpoints object.

checkpoints?CheckpointsOrCheckpointsId

The Checkpoints object to be accessed: omit for the default context Checkpoints object, provide an Id for a named context Checkpoints object, or provide an explicit reference.

debugIds?boolean

Whether the component should also render the Id of the checkpoint to assist with debugging.

Since

v1.0.0