diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-05 11:41:46 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-05 11:41:46 +0200 |
commit | f653a01328be3b8be6af35c0c96867623765ca5b (patch) | |
tree | aee9a5d3abfc39270f55defd7bc1a7e47920ffc3 /static/README.md | |
parent | Minor whitespace cleanup. (diff) | |
download | calp-f653a01328be3b8be6af35c0c96867623765ca5b.tar.gz calp-f653a01328be3b8be6af35c0c96867623765ca5b.tar.xz |
Move JS documentation into the JS-code.
Texinfo was a bad match for how TypeScript is structured. This also
allows generation of jsdoc pages, which can be nice.
Another large win is that this opens up for the texinfo pages to replace
the Guile heading with different subheadings, including
- external library
- internal library
- C library
- ...
Diffstat (limited to '')
-rw-r--r-- | static/README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/static/README.md b/static/README.md index e69de29b..fe5f775c 100644 --- a/static/README.md +++ b/static/README.md @@ -0,0 +1,36 @@ +The frontend code has its entry-point in `script.ts`. + +## web components + +All elements are initialized in components.ts + +#### Boolean attributes +Some components have properties/accessors which also appears as attributes on +the actuall component (usually with a two-way maping). + +For boolean attributes, the attribute is either present or absent. + +### General Components +- `components/date-time-input.ts` +- `components/input-list.ts` + +### VEvent Components +- `components/vevent.ts` +- `components/changelog.ts` +- `components/edit-rrule.ts` +- `components/popup-element.ts` +- `components/tab-group-element.ts` +- `components/vevent-block.ts` +- `components/vevent-description.ts` +- `components/vevent-dl.ts` +- `components/vevent-edit.ts` + +## About our buildsystem + +Currently (almost) everything is written in Typescript, and bundled +through browserify. Ideally we would, for debug builds, export the +single transplied Javascript files, but Chromium Chromium lacks +support for modules on XHTML documents +https://bugs.chromium.org/p/chromium/issues/detail?id=717643. +However, seeing as the issue still gets frequent updates as of 2021 I +believe that this might one day get resolved. |