Skip to content

Commit

Permalink
Clarify record sidebar configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
kspurgin committed Feb 28, 2024
1 parent e04eb31 commit 8682a1c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/configuration/RecordSidebarConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ The sidebar that is displayed when viewing or editing a record may be configured

Currently only the related records that are displayed may be configured, by supplying an array of related record descriptors. A related record panel will be displayed for each descriptor, in the order listed.

**NOTE: This configuration controls the related record *tables* in the sidebar. It does *not* affect/control the media snapshot panel that appears at the top of the sidebar in Object records. See [the `mediaSnapshotSort` setting](./README.md#mediaSnapshotSort) to control order of display in that panel.**

```
type SidebarDescriptor = {
relatedRecords: Array<RelatedRecordDescriptor>,
Expand Down Expand Up @@ -49,7 +51,7 @@ A record type name, which must correspond to a key in the [recordTypes](./Record
```
columnSet: string = 'narrow'
```
A column set name, which must correspond to a key in the [columns](./ColumnConfiguration) configuration for the specified record type.
A column set name, which should correspond to a key in the [columns](./ColumnConfiguration) configuration for the specified record type. If the specified column set does not exist for the specified record type, the `default` columnSet for the record typewill be used.

### sort
```
Expand Down

0 comments on commit 8682a1c

Please sign in to comment.