Skip to content

Commit

Permalink
Fix: Update to ES6 syntax (fixes #40)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverfoster committed May 24, 2024
2 parents 1cb3666 + 55b766c commit d770978
Show file tree
Hide file tree
Showing 3 changed files with 218 additions and 185 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* A sentence describing each fix

### Update
* A sentence describing each udpate
* A sentence describing each update

### New
* A sentence describing each new feature
Expand Down
72 changes: 67 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,70 @@
adapt-pageIncompletePrompt
==========================
# adapt-pageIncompletePrompt

Displays a prompt if you try and leave a page without having completed all components.
**Page Incomplete Prompt** is an extension that displays a prompt if you try to leave a page without having completed all required components.

Can be configured globally in course.json, or per page in contentObjects.json.
NOTE: the contentObjects.json setting will override whatever is in course.json.
## Settings Overview

**Page Incomplete Prompt** can be configured globally in *course.json*, or per page in *contentObjects.json*. The *contentObjects.json* setting will override whatever is in *course.json*.

## Attributes

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

### *course.json*

The following attributes are set within *course.json*.

### **\_pageIncompletePrompt** (object)

The Page Incomplete Prompt object contains the following settings:

#### **\_isEnabled** (boolean)

Controls whether the extension is enabled

### **title** (string)

The title of the prompt popup

### **message** (string)

The message body of the prompt popup

### **_classes** (string)

CSS class names to be applied to the prompt popup. The class must be predefined in one of the Less files. Separate multiple classes with a space.

### **\_buttons** (object)

This object contains the following settings:

#### **yes** (string)

The text that appears on the 'yes' confirmation button

#### **no** (string)

The text that appears on the 'no' button

### *contentObjects.json*

The following attributes are set within *contentObjects.json*.

### **\_pageIncompletePrompt** (object)

The Page Incomplete Prompt object contains the following settings:

#### **\_isEnabled** (boolean)

Controls whether the extension is enabled for the page

## Limitations

No known limitations.

----------------------------

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

0 comments on commit d770978

Please sign in to comment.