TinyBase logoTinyBase

CurrentCheckpointProps

CurrentCheckpointsProps props are used for components that refer to the current checkpoints in a Checkpoints object, such as the BackwardCheckpointsView component.

{
  checkpoints?: CheckpointsOrCheckpointsId;
  checkpointComponent?: ComponentType<CheckpointProps>;
  getCheckpointComponentProps?: (checkpointId: Id) => ExtraProps;
  debugIds?: boolean;
}
TypeDescription
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.

checkpointComponent?ComponentType<CheckpointProps>

A component for rendering each checkpoint in the Checkpoints object.

getCheckpointComponentProps?(checkpointId: Id) => ExtraProps

A function for generating extra props for each checkpoint component based on its Id.

debugIds?boolean

Whether the component should also render the Ids of the checkpoints to assist with debugging.

Since

v1.0.0