diff options
Diffstat (limited to 'static/ts/components/vevent-description.ts')
| -rw-r--r-- | static/ts/components/vevent-description.ts | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/static/ts/components/vevent-description.ts b/static/ts/components/vevent-description.ts index b44185e7..bf62c10d 100644 --- a/static/ts/components/vevent-description.ts +++ b/static/ts/components/vevent-description.ts @@ -1,3 +1,19 @@ +/** + * `<vevent-description />` + +A text representation of a VEvent. Used as the summary tab of our +popup windows, and in the sidebar. + +When redrawn, it looks for an HTML-tag inside its template having the +attribute `data-property` matching the properties name. If one is +found, it looks in the `formatters` table +({@link formatters}), for a field matching the property value, and +defaults to the key `default`. + * + * @category Web Components + * @mergeTarget components + * @module + */ export { ComponentDescription } import { VEvent } from '../vevent' |