adapt-homeButton

Home Button is an extension that adds more control to the standard home and back buttons.

Settings Overview

Home Button can be configured based on the specific location where it is used (e.g. a menu or a page). Options include:

• Hiding either the home and/or back button. One or both can appear in the navigation at the same time.
• Changing the text of the buttons
• Redirecting the button to a specific location (e.g. an introductory page)

Attributes

All configuration options must be added and amended, where appropriate, for all JSON files.

config.json

The following attributes are set within config.json.

_homeButton (object): The Home Button object contains the following settings:

_isEnabled (boolean): Controls whether the Home Button extension is enabled.

course.json

The following attributes are set within course.json under _extensions. These are used to set some default and global settings.

_extensions._homeButton (object): The Home Button object contains the following settings:

_navOrder (number): The order that the button appears in the navigation.

_showLabel (boolean): Controls whether the button should use a navigation label or just an icon.

alt (string): The button's aria-label text. Used to override global setting.

navLabel (string): The button label text as it appears in the navigation.

_navTooltip (object): The Navigation Tooltip object contains the following settings:

_isEnabled (boolean): Controls whether the navigation tooltip is enabled.

text (string): The text of the tooltip. Used to override global setting.

course.json and contentObjects.json

The following attributes are set within course.json and / or contentObjects.json. These are used to customize the button for a specific menu or page.

_homeButton (object): The Home Button object contains the following settings:

_isEnabled (boolean): Controls whether the Home Button extension is enabled.

_isInherited (boolean): Controls whether to use the course defaults defined in course.json under _extensions._homeButton. If disabled, the current content object's settings will be used in place of the course defaults. Properties inherited include alt, navLabel, and _navTooltip. Defaults to true.

_hideHomeButton (boolean): Controls whether the home button is hidden or not.

_hideBackButton (boolean): Controls whether the back button is hidden or not. Applies to contentObjects.json only.

_redirectToId (string): The page ID that the home button should redirect the user to. Use when overriding standard behaviour such as redirecting to an introductory page from the menu.

_iconClasses (string): CSS class name to override the default home button icon application. Default application for the home button is icon-home on all pages with icon-controls-left on the menu. If an override is applied to course.json the override will apply to the menu and all pages. If an override is applied to contentObjects.json the override will only apply specifically to that page.

alt (string): The button's aria-label text. Used to override global setting.

navLabel (string): The button label text as it appears in the navigation. Used to override global setting.

_navTooltip (object): The Navigation Tooltip object contains the following settings:

_isEnabled (boolean): Controls whether the navigation tooltip is enabled. Used to override global setting.

text (string): The text of the tooltip. Used to override global setting.

Limitations

No known limitations.

---

Author / maintainer: CGKineo
Accessibility support: WAI AA
RTL support: Yes
Cross-platform coverage: Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, Safari for macOS/iOS/iPadOS, Opera