New: Add support for Tooltip API and Navigation Button API (fix #128)

[swashbuck]

Fix #128

New

• Add navigation button label and tooltip support

Testing

• See course.json config in the updated example.json

[oliverfoster]

Could you nest the config one deeper? course.json:_devtools._navButton.ariaLabel rather than course.json:_devtools.ariaLabel.
As it's a subpart of devtools.

_navButton / _nav, something like that?

adapt-devtools/schema/course.schema.json

Lines 11 to 31 in becbff3

	"_globals": {
	"type": "object",
	"default": {},
	"properties": {
	"_extensions": {
	"type": "object",
	"default": {},
	"properties": {
	"_devtools": {
	"type": "object",
	"title": "Dev Tools",
	"default": {},
	"properties": {
	"ariaLabel": {
	"type": "string",
	"title": "Navigation button aria label",
	"default": "Developer tools",
	"_adapt": {
	"translatable": true
	}
	},

[kirsty-hames]

Works as expected thanks @swashbuck 👍

[kirsty-hames]

Could you nest the config one deeper? course.json:_devtools._navButton.ariaLabel rather than course.json:_devtools.ariaLabel. As it's a subpart of devtools.

_navButton / _nav, something like that?

adapt-devtools/schema/course.schema.json

Lines 11 to 31 in becbff3

	"_globals": {
	"type": "object",
	"default": {},
	"properties": {
	"_extensions": {
	"type": "object",
	"default": {},
	"properties": {
	"_devtools": {
	"type": "object",
	"title": "Dev Tools",
	"default": {},
	"properties": {
	"ariaLabel": {
	"type": "string",
	"title": "Navigation button aria label",
	"default": "Developer tools",
	"_adapt": {
	"translatable": true
	}
	},

Good point. Annoyingly we haven't defined a consistent approach to how we've defined nav button aria labels (when comparing against pageLevelProgress, Visua11y and roleBasedContent each has a different approach). Instead would replacing _devtools.ariaLabel with _devtools.navAriaLabel be efficient to keep all nav button properties at the same level?

[oliverfoster]

You'd have to do _showLabel as well. It's probably easier just to nest them and keep the names as they are in NavigationButton API as these are just passthrough properties for a self-contained bit of behaviour.

[swashbuck]

Thanks, both. I've nested the properties under _navButton in 2d63b1b. Kept _navTooltip as it was. Let me know if this works and I can update ToC.

[oliverfoster]

Remember that we have migration scripts now if you want to harmonise these things.