New: Required and optional labels added (Fixes #191)

[zubairslamdien]

Fixes #191

To do ‼️

Will wait on general feedback before doing the following tasks:

• Schemas
• Migration scripts

New

• Optional and required labels added from Update: Mandatory and optional labels added to schema (fixes #520) adapt-contrib-core#521

Notes

• Can be configured to show optional labels, required labels, both or none
• Classes added so that the type of label can be styled differently (e.g. red labels for required and orange for optional)

Testing

Add to course.json:

"_boxMenu": {
  "_priorityLabels": {
    "_showPriorityWhenOptional": true,
    "_showPriorityWhenRequired": true
  }
}

Related

Styling: adaptlearning/adapt-contrib-vanilla#567

[StuartNicholls]

I'll leave the mock-up for the boxmenu item to @zubair but I've added a simple mock-up of a suggested use case for discussion

[swashbuck]

Updated PR description above.

Would be good to get feedback/approvals on the new config options before I do the schemas and migration scripts.

[oliverfoster]

Are priority labels needed in any other titles? Page, article, block, component?
If so, the code should live in the core heading module.

[swashbuck]

Are priority labels needed in any other titles? Page, article, block, component? If so, the code should live in the core heading module.

Having the labels available in other areas might be useful. However, Box Menu items do not currently use the core heading templates as they are set up a little differently. For instance, box menu items have an aria-label for the item graphic and do not have instruction text. Changes to the heading templates would be required.

If we did add priority labels to other titles, we would want fine-grained control. For instance, either add the object to each specific content object, article, block, and component:

"_priorityLabels": {
    "_showPriorityWhenOptional": true,
    "_showPriorityWhenRequired": false  
},

Or set global config for each type of element:

"_priorityLabels": {
    "_contentObject": {
        "_showPriorityWhenOptional": false,
        "_showPriorityWhenRequired": false
    },
    "_article": {
        "_showPriorityWhenOptional": false,
        "_showPriorityWhenRequired": false
    },
    "_block": {
        "_showPriorityWhenOptional": false,
        "_showPriorityWhenRequired": false
    },
    "_component": {
        "_showPriorityWhenOptional": true,
        "_showPriorityWhenRequired": false
    },
},

This seems like it would be a separate issue from adding to box menu items as it would apply to core elements rather than Box Menu which is a plugin.

[oliverfoster]

These are the places that ariaLabels are important:

https://github.com/adaptlearning/adapt-contrib-core/blob/df348fb89b5e5d58fd35db18b2cbb35471b05f51/js/enums/defaultAriaLevels.js#L2-L10

Often we have sub-contentobject settings, menu, page, menuitem, etc

It might be better to include the settings in core and have the boxMenu tie into it rather than having some settings in the plugin and some in the core.

[swashbuck]

These are the places that ariaLabels are important

@oliverfoster Could you clarify this comment about ariaLabels? The new priority labels do not use aria-level values, nor does the graphic ariaLabel.

It might be better to include the settings in core and have the boxMenu tie into it rather than having some settings in the plugin and some in the core.

Are you suggesting to move the logic that sets the priorityClass and priorityLabel model properties into Core? What did you have in mind?

[oliverfoster]

Sorry, no. I meant that contentobject is a group of multiple configurations that should probably be separated into its constituent parts. Use ariaLabels as the inspiration on which to granulate your settings.