Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for authoring tool 1 #125

Merged
merged 21 commits into from
Aug 3, 2021
Merged

Add support for authoring tool 1 #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
24a963a
Add schema
tomgreenfield Nov 16, 2020
1dfb0ef
Remove validators
tomgreenfield Nov 18, 2020
632a2c0
Bump version
tomgreenfield Nov 19, 2020
71ca992
Update URL
tomgreenfield Jan 21, 2021
6102b6f
Bump version
tomgreenfield Jan 21, 2021
8e2a6d9
Merge remote-tracking branch 'origin/master' into json-schema
tomgreenfield Mar 5, 2021
45ab590
Clarity first pass
tomgreenfield Mar 5, 2021
b7a3dec
Bump version
tomgreenfield Mar 5, 2021
c89c59c
Update schemas to use new $patch keyword
taylortom Mar 25, 2021
929ad53
Bump version
taylortom Mar 25, 2021
40316ef
Merge remote-tracking branch 'origin/master' into json-schema
tomgreenfield Apr 16, 2021
755cad8
Bump version
tomgreenfield Apr 16, 2021
b87151e
Bump versions
tomgreenfield May 6, 2021
e0f92e5
Merge remote-tracking branch 'origin/master' into json-schema
tomgreenfield Jun 1, 2021
a2f458e
Add new fields to schema
tomgreenfield Jun 1, 2021
042050a
Bump version
tomgreenfield Jun 1, 2021
69d46a6
Merge branch 'master' into json-schema
tomgreenfield Jul 8, 2021
0226f5d
Add _showEndOfPage to schema
tomgreenfield Jul 8, 2021
229515b
Merge branch 'master' into json-schema
tomgreenfield Jul 14, 2021
744fe0e
Bump version
tomgreenfield Jul 14, 2021
e4cde6b
Revert version for PR
tomgreenfield Aug 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 196 additions & 0 deletions schema/article.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
{
"$anchor": "trickle-article",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"$patch": {
"source": {
"$ref": "article"
},
"with": {
"properties": {
"_trickle": {
"type": "object",
"title": "Trickle",
"default": {},
"required": [
"_scrollDuration"
],
"properties": {
"_isEnabled": {
"type": "boolean",
"title": "Enable Trickle",
"default": false
},
"_autoScroll": {
"type": "boolean",
"title": "Scroll automatically",
"default": false
},
"_scrollDuration": {
"type": "number",
"title": "Scroll duration",
"description": "Duration of the scroll animation in milliseconds",
"default": 500
},
"_onChildren": {
"type": "boolean",
"title": "Enable on child blocks",
"description": "Set to false on the article to use trickle at article level",
"default": false
},
"_scrollTo": {
"type": "string",
"title": "Scroll target",
"description": "Set how trickle scrolls",
"default": "@block +1"
},
"_button": {
"type": "object",
"title": "Button",
"default": {},
"required": [
"_styleBeforeCompletion",
"_styleAfterClick"
],
"properties": {
"_isEnabled": {
"type": "boolean",
"title": "Add Trickle button",
"default": false
},
"_styleBeforeCompletion": {
"type": "string",
"title": "Visibility before completion",
"default": "hidden",
"enum": [
"hidden",
"visible",
"disabled"
],
"_backboneForms": "Select"
},
"_styleAfterClick": {
"type": "string",
"title": "Visibility after completion",
"default": "hidden",
"enum": [
"hidden",
"visible",
"disabled"
],
"_backboneForms": "Select"
},
"_isFullWidth": {
"type": "boolean",
"title": "Make full width",
"default": true
},
"_autoHide": {
"type": "boolean",
"title": "Hide button when no longer in view",
"description": "Hides the button when it scrolls from view; not recommended for use in courses that need to be screenreader compatible",
"default": false
},
"_showEndOfPage": {
"type": "boolean",
"title": "Show end of page button",
"default": true
},
"_className": {
"type": "string",
"title": "Custom classes",
"default": ""
},
"_hasIcon": {
"type": "boolean",
"title": "Enable icon",
"description": "Displays an icon alongside, or in place of, the Trickle button text. Default icon is a small downwards arrow",
"default": false
},
"text": {
"type": "string",
"title": "Default button text",
"default": "Continue",
"_adapt": {
"translatable": true
}
},
"ariaLabel": {
"type": "string",
"title": "Default button ARIA label",
"default": "Continue",
"_adapt": {
"translatable": true
}
},
"startText": {
"type": "string",
"title": "First button text",
"description": "Only on articles when 'Enable on child blocks' set to true",
"default": "Begin",
"_adapt": {
"translatable": true
}
},
"startAriaLabel": {
"type": "string",
"title": "First button ARIA label",
"description": "Only on articles when 'Enable on child blocks' set to true",
"default": "Begin",
"_adapt": {
"translatable": true
}
},
"finalText": {
"type": "string",
"title": "Final button text",
"description": "Only on articles when 'Enable on child blocks' set to true",
"default": "Finish",
"_adapt": {
"translatable": true
}
},
"finalAriaLabel": {
"type": "string",
"title": "Final button ARIA label",
"description": "Only on articles when 'Enable on child blocks' set to true",
"default": "Finish",
"_adapt": {
"translatable": true
}
},
"_component": {
"type": "string",
"title": "Trickle plugin",
"default": "trickle-button"
}
}
},
"_stepLocking": {
"type": "object",
"title": "Step locking",
"default": {},
"properties": {
"_isEnabled": {
"type": "boolean",
"title": "Hide subsequent content",
"default": true
},
"_isCompletionRequired": {
"type": "boolean",
"title": "Require content to be completed",
"default": true
},
"_isLockedOnRevisit": {
"type": "boolean",
"title": "Reset state on revisit",
"default": false
}
}
}
}
}
}
}
}
}
191 changes: 191 additions & 0 deletions schema/block.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
{
"$anchor": "trickle-block",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"$patch": {
"source": {
"$ref": "block"
},
"with": {
"properties": {
"_trickle": {
"type": "object",
"title": "Trickle",
"default": {},
"required": [
"_scrollDuration"
],
"properties": {
"_isEnabled": {
"type": "boolean",
"title": "Enable Trickle",
"default": false
},
"_isInherited": {
"type": "boolean",
"title": "Inherit settings from parent article",
"default": false
},
"_autoScroll": {
"type": "boolean",
"title": "Scroll automatically",
"default": false
},
"_scrollDuration": {
"type": "number",
"title": "Scroll duration",
"description": "Duration of the scroll animation in milliseconds",
"default": 500
},
"_scrollTo": {
"type": "string",
"title": "Scroll target",
"description": "Set how trickle scrolls",
"default": "@block +1"
},
"_button": {
"type": "object",
"title": "Button",
"default": {},
"properties": {
"_isEnabled": {
"type": "boolean",
"title": "Add Trickle button",
"default": true
},
"_styleBeforeCompletion": {
"type": "string",
"title": "Visibility before completion",
"default": "hidden",
"enum": [
"hidden",
"visible",
"disabled"
],
"_backboneForms": "Select"
},
"_styleAfterClick": {
"type": "string",
"title": "Visibility after completion",
"default": "hidden",
"enum": [
"hidden",
"visible",
"disabled"
],
"_backboneForms": "Select"
},
"_isFullWidth": {
"type": "boolean",
"title": "Make full width",
"default": true
},
"_autoHide": {
"type": "boolean",
"title": "Hide button when no longer in view",
"description": "Hides the button when it scrolls from view; not recommended for use in courses that need to be screenreader compatible",
"default": false
},
"_showEndOfPage": {
"type": "boolean",
"title": "Show end of page button",
"default": true
},
"_className": {
"type": "string",
"title": "Custom classes",
"default": ""
},
"_hasIcon": {
"type": "boolean",
"title": "Enable icon",
"description": "Displays an icon alongside, or in place of, the Trickle button text. Default icon is a small downwards arrow",
"default": false
},
"text": {
"type": "string",
"title": "Default button text",
"default": "Continue",
"_adapt": {
"translatable": true
}
},
"ariaLabel": {
"type": "string",
"title": "Default button ARIA label",
"default": "Continue",
"_adapt": {
"translatable": true
}
},
"startText": {
"type": "string",
"title": "First button text",
"description": "Only on articles when 'Enable on child blocks' set to true",
"default": "Begin",
"_adapt": {
"translatable": true
}
},
"startAriaLabel": {
"type": "string",
"title": "First button ARIA label",
"description": "Only on articles when 'Enable on child blocks' set to true",
"default": "Begin",
"_adapt": {
"translatable": true
}
},
"finalText": {
"type": "string",
"title": "Final button text",
"description": "Only on articles when 'Enable on child blocks' set to true",
"default": "Finish",
"_adapt": {
"translatable": true
}
},
"finalAriaLabel": {
"type": "string",
"title": "Final button ARIA label",
"description": "Only on articles when 'Enable on child blocks' set to true",
"default": "Finish",
"_adapt": {
"translatable": true
}
},
"_component": {
"type": "string",
"title": "Trickle plugin",
"default": "trickle-button"
}
}
},
"_stepLocking": {
"type": "object",
"title": "Step locking",
"default": {},
"properties": {
"_isEnabled": {
"type": "boolean",
"title": "Hide subsequent content",
"default": true
},
"_isCompletionRequired": {
"type": "boolean",
"title": "Require content to be completed",
"default": true
},
"_isLockedOnRevisit": {
"type": "boolean",
"title": "Reset state on revisit",
"default": false
}
}
}
}
}
}
}
}
}
Loading