v11 Release notes

[phun-ky]

11.0.0 (2024-08-28)

Changelog

v11 released 28th 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

• update
• documentation
• better api

The SPECCER v11 release includes an updated documentation, some changes to the API, with a minor design change regarding the measure feature.

Overview

SPECCER v11 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

• SPECCER features now utilizes an options object where applicable
• The default look and feel for the measure feature has changed, if you want the old look and feel, use slim
• Updated the documentation with new screenshots

Commits

⚠ BREAKING CHANGES

• 🧨 Have changed the API to accept an option object instead of a string. Please check the documentation.
• 🧨 While setting a new default feature seems appropriate, it does not come without consequence. This is a breaking change, since the default of the API has changed. Please use the slim version if you want that instead of the new version.
• 🧨 Have changed the API to accept an option object instead of a string. Please check the documentation.

Tasks

• 🤖 Regenerate docs (fb5ec15)
• 🤖 Update dev files (c89f435)
• 🤖 Update/add dev files (0a0d68f)

Documentation

• ✏️ Regenerate API documentation (065a3f6)
• ✏️ Update README.md (367f4b8)
• ✏️ Update and correct documentation (288bdcf)
• ✏️ Update screenshots (152e9d5), closes #233
• ✏️ Update section with lower heading level (8ec137e)

Feature

• 🎸 Add isSlimArea to help with the old measure feat (dd8e13b)
• 🎸 Add feature to pin text elements (46f88f8), closes #258
• 🎸 Add new default measure feature, keep old as slim. (7c74c5e), closes #124
• 🎸 Make it possible to add literals via attribute (a7d863d)

Bug

• 🐛 Add missing landmark, form (a8633a2)
• 🐛 Add missing style overrides (bcfce82)
• 🐛 Use correct y value with scrollTop (dfeff17)
• 🐛 Use correct variable for height calculation (d31fbba)

Performance change

• ⚡️ Use forEach instead of for...of for speedier render (6c3dda3)

Refactoring

• 💡 Adjust positioning of tabstop (2d53f9a)
• 💡 Improve spacing feature (95e7bae)
• 💡 Move out createA11yElement function (8ba8591)
• 💡 Update values for --ph-speccer-line-width (8fe180a)
• 💡 Update values for mark (721221d)
• 💡 Use options object instead of area strings (3560dda)

What’s not changing

• All features are still present and usable, you just need to make sure you want to use the new default look for the measure feature, or stick with the slim feature.

Release FAQs

What are the benefits of SPECCER v11 for me?

• A more intuitive API

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

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

What will SPECCER support for v10?

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

What is the rule for supporting deprecated features?

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

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

• If applicable, a guide is provided to help with the migration process
• If you've used some features programatically, you might need to pass in an option: SpeccerOptionsInterface object instead of an area string.