Migration/docs: finish overlay and scrollspy parity cleanup #12

Closed
opened 2026-06-23 19:00:31 +00:00 by mik-tf · 1 comment
Owner

Parent tracker: #1

Objective: complete the public-facing migration, docs, and caveat cleanup after Tooltip, Popover, and Scrollspy parity implementations land.

Scope:

  • Update component docs and examples for the new typed props.
  • Remove or rewrite completed caveats from docs/DESIGN.md.
  • Update migration converter for safe static tooltip/popover/scrollspy Bootstrap attributes where possible.
  • Flag dynamic or ambiguous Bootstrap attributes for manual review instead of guessing.
  • Keep raw-Bootstrap gate aligned with the typed surface.

Acceptance criteria:

  • Docs reflect the implemented behavior and no longer describe completed parity work as a caveat.
  • Converter fixtures cover safe static tooltip/popover/scrollspy mappings where implemented.
  • npm run test:migrate, npm run lint:bootstrap, and relevant e2e checks pass.
  • Issue #1 can be closed after this issue and the implementation issues are complete.

Dependencies: tooltip parity, popover parity, and scrollspy parity issues.

Signed-by: mik-tf mik-tf@noreply.invalid

Parent tracker: https://forge.ourworld.tf/lhumina_code/dioxus-bootstrap-css/issues/1 Objective: complete the public-facing migration, docs, and caveat cleanup after Tooltip, Popover, and Scrollspy parity implementations land. Scope: - Update component docs and examples for the new typed props. - Remove or rewrite completed caveats from `docs/DESIGN.md`. - Update migration converter for safe static tooltip/popover/scrollspy Bootstrap attributes where possible. - Flag dynamic or ambiguous Bootstrap attributes for manual review instead of guessing. - Keep raw-Bootstrap gate aligned with the typed surface. Acceptance criteria: - Docs reflect the implemented behavior and no longer describe completed parity work as a caveat. - Converter fixtures cover safe static tooltip/popover/scrollspy mappings where implemented. - `npm run test:migrate`, `npm run lint:bootstrap`, and relevant e2e checks pass. - Issue #1 can be closed after this issue and the implementation issues are complete. Dependencies: tooltip parity, popover parity, and scrollspy parity issues. Signed-by: mik-tf <mik-tf@noreply.invalid>
Author
Owner

Implemented migration/docs cleanup in 77e629efdf.

Summary:

  • Rewrote docs/PARITY.md from pre-implementation target language into current Tooltip, Popover, and Scrollspy behavior.
  • Updated docs/MIGRATION.md and tools/README.md with static Tooltip/Popover converter rules and Scrollspy manual-review rules.
  • Replaced completed caveat wording in docs/DESIGN.md with current implementation notes.
  • Added converter support for safe static Tooltip and Popover data attributes: text/body, placement, trigger, and custom class.
  • Added Scrollspy manual-review detection because typed Scrollspy requires an app-owned Signal.
  • Aligned the raw-Bootstrap gate with Tooltip/Popover raw classes and docs/MIGRATION.md.
  • Added converter fixtures for overlays and Scrollspy manual review.

Verification:

  • cargo fmt --all -- --check
  • cargo clippy --target wasm32-unknown-unknown -p dioxus-bootstrap-css -- -D warnings
  • cargo clippy --target wasm32-unknown-unknown -p showcase -- -D warnings
  • cargo check --target wasm32-unknown-unknown -p dioxus-bootstrap-css
  • cargo check --target wasm32-unknown-unknown -p showcase
  • cargo test -p dioxus-bootstrap-css
  • npm run test:migrate
  • npm run lint:bootstrap
  • npm run test:e2e -- --grep "tooltip|popover|scrollspy" (12 passed)
  • git diff --check
  • Forge CI run 25 is green.

Signed-by: mik-tf mik-tf@noreply.invalid

Implemented migration/docs cleanup in 77e629efdf9dfec60a986171e32a3ccb3ad80b91. Summary: - Rewrote docs/PARITY.md from pre-implementation target language into current Tooltip, Popover, and Scrollspy behavior. - Updated docs/MIGRATION.md and tools/README.md with static Tooltip/Popover converter rules and Scrollspy manual-review rules. - Replaced completed caveat wording in docs/DESIGN.md with current implementation notes. - Added converter support for safe static Tooltip and Popover data attributes: text/body, placement, trigger, and custom class. - Added Scrollspy manual-review detection because typed Scrollspy requires an app-owned Signal<String>. - Aligned the raw-Bootstrap gate with Tooltip/Popover raw classes and docs/MIGRATION.md. - Added converter fixtures for overlays and Scrollspy manual review. Verification: - cargo fmt --all -- --check - cargo clippy --target wasm32-unknown-unknown -p dioxus-bootstrap-css -- -D warnings - cargo clippy --target wasm32-unknown-unknown -p showcase -- -D warnings - cargo check --target wasm32-unknown-unknown -p dioxus-bootstrap-css - cargo check --target wasm32-unknown-unknown -p showcase - cargo test -p dioxus-bootstrap-css - npm run test:migrate - npm run lint:bootstrap - npm run test:e2e -- --grep "tooltip|popover|scrollspy" (12 passed) - git diff --check - Forge CI run 25 is green. Signed-by: mik-tf <mik-tf@noreply.invalid>
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
lhumina_code/dioxus-bootstrap-css#12
No description provided.