Skip to content

Draft: Make map and tour compatible

Timm Fitschen requested to merge f-map-tour into dev

Summary

Add a map_read event to the map module and extend the tour framework such that the initialization of tour pages can be triggered by events.

Focus

  • straight-forward additions in src/core/js/ext_map.js
  • The central change in src/core/js/tour.js is the implementation of a new config option for the Page class, init which may have properties target and event. If present, the tour.Page#_init function is called when the event is captured at the target. target defaults to document.body if undefined.
  • Note that I also refactored the logging in src/core/js/tour.js

Test Environment

The best manual testing is probably together with the map tour chapter in caosdb-deploy in branch f-tour where I already updated the tour.yaml.

Be sure to reset the tour (or remove the old tour state in your localStorage).

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

  • All automated tests pass
  • Reference related Issues
  • Up-to-date CHANGELOG.md
  • Annotations in code (Gitlab comments)
    • Intent of new code
    • Problems with old code
    • Why this implementation?

Check List for the Reviewer

  • I understand the intent of this MR
  • All automated tests pass
  • Up-to-date CHANGELOG.md
  • The test environment setup works and the intended behavior is reproducible in the test environment
  • In-code documentation and comments are up-to-date.
  • Check: Are there spezifications? Are they satisfied?

For further good practices have a look at our review guidelines.

Edited by Timm Fitschen

Merge request reports