0.15.0 • Published 5 years ago
@pndr/link-to-another-record-field v0.15.0
LinkToAnotherRecordField
Used for linking to a foreign record.
Prop Types
| Property | Type | Required? | Description |
|---|---|---|---|
| id | String | ✓ | Unique id for the instance of this field |
| contextId | Context | ✓ | The appearance will change depending on context in which the field is displayed. Valid options include: recordDetail or recordGridRow or recordGalleryCard or recordListItem |
| roleId | Role | ✓ | The behaviour changes based on the role. Valid options include editor or readOnly |
| recordCount | Number | ✓ | Number of records linked |
| recordGetter | Function | ✓ | Callback responsible for returning a data row given an index. ({index: int}) |
| recordRenderer | Function | ✓ | Responsible for rendering a linked record. ({key: int, onClick: fn, onUnlink: fn, recordData: any, roleId: string}): jsx |
| onRecordClick | Function | Callback invoked whenever a linked record get's clicked: ({id: string, recordId: string}): void | |
| onRecordUnlink | Function | Callback invoked whenever the unlink button is clicked for a linked record.: ({id: string, recordId: string}): void |
More information
This component is designed and developed as part of Cosmos Design System.