palcarazm / bootstrap5-toggle / 40002210761

95%

v5: 95%

push

github

docs: add async lifecycle notes to Usage, InputInteraction, and Methods

Document the v5.5.0 async timing behavior introduced by the
component-lifecycle integration (#317):

- Usage: note that `[data-toggle="toggle"]` auto-init awaits
  `init().then(attach)`, and that `element.bootstrapToggle()` returns
  synchronously while starting the lifecycle in a microtask.
- InputInteraction: footnote that the table demos assume the toggle is
  already attached; recommend `await input.bsToggle.attach()` or
  `input.bsToggle.update()` right after `.bootstrapToggle()`.
- Methods: "Async teardown" callout explaining that `destroy()` and
  `rerender()` return `Promise<void>`, with an `await` sample and a note
  that `rerender()` emits `toggle:disposed` and `toggle:attached`.
- DocArticle: add a `fragment(...)` helper so multi-node descriptions
  can be passed to `DocArticle.build({ description })`.

Implements #373

404 of 443 branches covered (91.2%)

Branch coverage included in aggregate %.

497 of 504 relevant lines covered (98.61%)

161.11 hits per line