add documentation as to why we need the label hint for EventTimelineView

This commit is contained in:
Scott Bell 2025-03-07 11:24:13 +01:00
parent bbae9c6048
commit 55d15caa63

@ -43,6 +43,8 @@ class EventMetadataProvider {
name: 'Message',
format: 'string',
hints: {
// this is used in the EventTimelineView to provide a title for the event
// label can be changed to other properties for the title (e.g., the `name` property)
label: 0
}
}