v10 Release notes

[phun-ky]

10.0.0 (2024-08-19)

Changelog

v10 released 19th of August 2024, and here are the release notes, and any notable changes are described.

The release includes, but not limited to features, documentation, refactoring and bug fixes. For any questions, please contact me!

Note

Release notes are only given for major, breaking changes.

Keywords

• refactor
• better api

The SPECCER v10 release includes an updated API, quality of life updates for developers, with no design changes.

Overview

SPECCER v10 focuses on quality of life for devs (me), and the users of SPECCER. The API is more reflected to the usage of the features, with a nomenclature describing better what the feature does.

What’s new

• Renamed all speccer feature inits from data-speccer-* to data-speccer="*". So a migration should be fairly easy by a search and replace.
• "Anatomy" feature is now called "Pin" feature, and initialization is now data-speccer="pin".
• Renamed data-anatomy-section to data-pin-area.
• The anatomy feature outline is now called pin.
• Some CSS variables have been renamed, more have been added.
• Stylus files has been split up, making developing easier.

Commits

⚠ BREAKING CHANGES

• 🧨 The API has changed! Please refer to the README.md and api
  documentation for this! You should migrate easily to the current version
  by search and replace.
• 🧨 Placements of the stylus files has now changed!
• The names of some CSS Variables have been changed. Please update your styling and overrides to reflect this!

Tasks

• 🤖 Regenerate documentation (6b04256)
• 🤖 Remove cobertura.xml, I don't know why it's there (a432f25)
• 🤖 Update new css variable references (7eeb0e4)

Documentation

• ✏️ Add notes about donation for current causes (34aeb83)
• ✏️ Fix changelog link in README.md (6cb956b)
• ✏️ Improve README.md (bfac2e5)
• ✏️ Rearrange some chapters in README.md (5385fb8)
• ✏️ Rearrange start of README.md (b5c07c3)
• ✏️ Update SECURITY.md (3b8361e)

Bug

• 🐛 Use correct left and top position for measure (87b120a)
• 🐛 Use css variable with base color fallback for svg els (38d1bea)

Refactoring

• 💡 Move styles to respective feature, and split out (ac72215)
• 💡 Rename files and functions to better reflect what (7e19c66), closes #225
• 💡 Untangle some styles, split out some files (642ce54), closes #29

What’s not changing

• All features are still present and usable, you just need to update the init code to reflect the new API

Release FAQs

What are the benefits of SPECCER v10 for me?

• A more intuitive API

Do I need to update right away? If not, when will we need to update?

• SPECCER v10 includes functionality that may be a motivator for migration, but developers can migrate to v10 when they have the bandwidth
• Developers that are using v9 today can continue to stay on v9 and everything that is implemented will continue to work

What will SPECCER support for v9?

• Nothing. Any noteable bugs will be adressed, but no guarantee it will be fixed for v9

What is the rule for supporting deprecated features?

• Assets that were deprecated from v8 to v9 will be removed in v10
• Assets that are deprecated in v9 will remain in v10 and will be removed in v11. The timeline of v11 has not been set

How big is the expected effort to migrate code to v10?

• If applicable, a guide is provided to help with the migration process
• A lot of the changes made will be name-based, so a search and replace will most likely to the trick