TinyBase logoTinyBase β

RemoteRowProps

RemoteRowProps props are used for components that refer to a single Relationship in a Relationships object, and where you want to render a remote Row based on a local Row, such as in the RemoteRowView component.

{
  relationshipId: Id;
  localRowId: Id;
  relationships?: RelationshipsOrRelationshipsId;
  rowComponent?: ComponentType<RowProps>;
  getRowComponentProps?: (rowId: Id) => ExtraProps;
  debugIds?: boolean;
}
TypeDescription
relationshipIdId

The Id of the Relationship in the Relationships object.

localRowIdId

The Id of the local Row for which to render the remote Row.

relationships?RelationshipsOrRelationshipsId

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

rowComponent?ComponentType<RowProps>

A component for rendering each (remote, local, or linked) Row in the Relationship.

getRowComponentProps?(rowId: Id) => ExtraProps

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

debugIds?boolean

Whether the component should also render the Id of the Row in the Relationship, and its descendent objects, to assist with debugging.

Since

v1.0.0