adapt-nav-link

Nav link is an extension for the Adapt framework.

This extension allows buttons to be added to an article, block or component which links to another location.

Installation

This extension must be manually installed.

If Nav link has been uninstalled from the Adapt authoring tool, it may be reinstalled using the Plug-in Manager.

Settings Overview

Nav link may be configured on four levels: page/menu (contentObjects.json), article (articles.json), block (blocks.json), and component (components.json).

The attributes listed below are properly formatted as JSON in example.json.

Attributes

Page / menu

The Nav link attribute group at page and menu level contains values for _isEnabled, _navigationID, _classes, _location, and _items.

_isEnabled (boolean): Turns on and off the Nav link extension. Can be set to disable Nav link when not required.

_navigationID (string): This defines a name for the page which a nav link button can link to.

_classes (string): Defines a css class that is included in the theme.

_location (string): Defines the position of the button. Options are "Below content", and "Bottom of page". The default is "Below content".

_items (array): This _items attributes group stores the properties for a button. It contains values for _requireElementCompleted, _requireCourseCompleted, _requireAssessmentPassed, _hideAfterClick, text, _icon, _link, link, and _ariaLabel.

_requireElementCompleted (boolean): If enabled, the button will be hidden until the Page or Menu the Nav link extension is enabled on is complete.

_requireCourseCompleted (boolean): If enabled, the button will be hidden until the course is completed.

_requireAssessmentPassed (boolean): If enabled, the button will be hidden until the assessment is passed.

_hideAfterClick (boolean): If enabled, the button will be hidden when the user selects it.

text (string): Defines the title on the button.

_icon (string): Class name for the icon. The class should be defined in the theme.

_link (string): Defines the destination of the button link. Options are "Parent page", "Next page", "Previous page", "Navigation ID", and "Custom". The default is "Parent page".

_navigationID (string): If "Navigation ID" is set then this defines which page the button links to.

link (string): If "Custom" is set then this defines the ID of the element the button links to.

_ariaLabel (string): This text becomes the button’s Aria label attribute.

Article / Block / Component

The Nav link attribute group contains values for _isEnabled, _classes, _location, and _items.

_isEnabled (boolean): Turns on and off the Nav link extension. Can be set to disable Nav link when not required.

_classes (string): Defines a css class that is included in the theme.

_location (string): Defines the position of the button. Options are "Below content", and "Bottom of page". The default is "Below content".

_items (array): This _items attributes group stores the properties for a button. It contains values for _requireElementCompleted, _requireCourseCompleted, _requireAssessmentPassed, _hideAfterClick, text, _icon, _link, link, and _ariaLabel.

_requireElementCompleted (boolean): If enabled, the button will be hidden until the Article, Block or Component the Nav link extension is enabled on is complete.

_requireCourseCompleted (boolean): If enabled, the button will be hidden until the course is completed.

_requireAssessmentPassed (boolean): If enabled, the button will be hidden until the assessment is passed.

_hideAfterClick (boolean): If enabled, the button will be hidden when the user selects it.

text (string): Defines the title on the button.

_icon (string): Class name for the icon. The class should be defined in the theme.

_link (string): Defines the destination of the button link. Options are "Parent page", "Next page", "Previous page", "Next article", "Next block", "Next component", "Navigation ID", and "Custom". The default is "Parent page".

_navigationID (string): If "Navigation ID" is set then this defines which page the button links to.

link (string): If "Custom" is set then this defines the ID of the element the button links to.

_ariaLabel (string): This text becomes the button’s Aria label attribute.

Accessibility

Several elements of Nav link have been assigned a label using the aria-label attribute: Nav link. These labels are not visible elements. They are utilized by assistive technology such as screen readers. Should the label texts need to be customised, they can be found within the globals object in properties.schema.

Back to Top

---

Version number: 4.2.1
Framework versions supported: 5.8+
Author / maintainer: DeltaNet with contributors
Accessibility support: Yes
RTL support: Yes
Authoring tool support: yes