@pie-element/categorize 6.6.0 → 6.6.1-beta.587

package/docs/config-schema.json

@@ -35,6 +35,22 @@
         }
       }
     },
+    "spellCheck": {
+      "title": "ConfigureProp",
+      "type": "object",
+      "properties": {
+        "settings": {
+          "description": "Indicates if the item has to be displayed in the Settings Panel",
+          "type": "boolean",
+          "title": "settings"
+        },
+        "label": {
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+          "type": "string",
+          "title": "label"
+        }
+      }
+    },
     "scoringType": {
       "title": "ConfigureProp",
       "type": "object",
@@ -51,6 +67,11 @@
         }
       }
     },
+    "settingsPanelDisabled": {
+      "description": "Indicates if the settings panel is not available",
+      "type": "boolean",
+      "title": "settingsPanelDisabled"
+    },
     "studentInstructions": {
       "title": "ConfigureProp",
       "type": "object",
@@ -83,6 +104,130 @@
         }
       }
     },
+    "minChoices": {
+      "description": "Minimum number of choices",
+      "type": "number",
+      "title": "minChoices"
+    },
+    "maxChoices": {
+      "description": "Maximum number of choices",
+      "type": "number",
+      "title": "maxChoices"
+    },
+    "choicesPosition": {
+      "title": "ConfigureProp",
+      "type": "object",
+      "properties": {
+        "settings": {
+          "description": "Indicates if the item has to be displayed in the Settings Panel",
+          "type": "boolean",
+          "title": "settings"
+        },
+        "label": {
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+          "type": "string",
+          "title": "label"
+        }
+      }
+    },
+    "maxCategories": {
+      "description": "Maximum number of categories",
+      "type": "number",
+      "title": "maxCategories"
+    },
+    "minCategoriesPerRow": {
+      "description": "Minimum value of categories per row",
+      "type": "number",
+      "title": "minCategoriesPerRow"
+    },
+    "maxImageWidth": {
+      "title": "ConfigureMaxImageDimensionsProp",
+      "type": "object",
+      "properties": {
+        "teacherInstructions": {
+          "description": "Indicates the max dimension for images in teacher instructions",
+          "type": "number",
+          "title": "teacherInstructions"
+        },
+        "prompt": {
+          "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+          "type": "number",
+          "title": "prompt"
+        },
+        "rationale": {
+          "description": "Indicates the max dimension for images in rationale",
+          "type": "number",
+          "title": "rationale"
+        },
+        "choices": {
+          "description": "Indicates the max dimension for images in choices",
+          "type": "number",
+          "title": "choices"
+        },
+        "rowLabel": {
+          "description": "Indicates the max dimension for images in row labels",
+          "type": "number",
+          "title": "rowLabel"
+        },
+        "categoryLabel": {
+          "description": "Indicates the max dimension for images in category labels",
+          "type": "number",
+          "title": "categoryLabel"
+        }
+      }
+    },
+    "maxImageHeight": {
+      "title": "ConfigureMaxImageDimensionsProp",
+      "type": "object",
+      "properties": {
+        "teacherInstructions": {
+          "description": "Indicates the max dimension for images in teacher instructions",
+          "type": "number",
+          "title": "teacherInstructions"
+        },
+        "prompt": {
+          "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+          "type": "number",
+          "title": "prompt"
+        },
+        "rationale": {
+          "description": "Indicates the max dimension for images in rationale",
+          "type": "number",
+          "title": "rationale"
+        },
+        "choices": {
+          "description": "Indicates the max dimension for images in choices",
+          "type": "number",
+          "title": "choices"
+        },
+        "rowLabel": {
+          "description": "Indicates the max dimension for images in row labels",
+          "type": "number",
+          "title": "rowLabel"
+        },
+        "categoryLabel": {
+          "description": "Indicates the max dimension for images in category labels",
+          "type": "number",
+          "title": "categoryLabel"
+        }
+      }
+    },
+    "withRubric": {
+      "title": "ConfigureProp",
+      "type": "object",
+      "properties": {
+        "settings": {
+          "description": "Indicates if the item has to be displayed in the Settings Panel",
+          "type": "boolean",
+          "title": "settings"
+        },
+        "label": {
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+          "type": "string",
+          "title": "label"
+        }
+      }
+    },
     "showPrompt": {
       "description": "Determines whether prompt field will be displayed or not",
       "default": true,
@@ -118,6 +263,42 @@
           "title": "label"
         }
       }
+    },
+    "ConfigureMaxImageDimensionsProp": {
+      "title": "ConfigureMaxImageDimensionsProp",
+      "type": "object",
+      "properties": {
+        "teacherInstructions": {
+          "description": "Indicates the max dimension for images in teacher instructions",
+          "type": "number",
+          "title": "teacherInstructions"
+        },
+        "prompt": {
+          "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+          "type": "number",
+          "title": "prompt"
+        },
+        "rationale": {
+          "description": "Indicates the max dimension for images in rationale",
+          "type": "number",
+          "title": "rationale"
+        },
+        "choices": {
+          "description": "Indicates the max dimension for images in choices",
+          "type": "number",
+          "title": "choices"
+        },
+        "rowLabel": {
+          "description": "Indicates the max dimension for images in row labels",
+          "type": "number",
+          "title": "rowLabel"
+        },
+        "categoryLabel": {
+          "description": "Indicates the max dimension for images in category labels",
+          "type": "number",
+          "title": "categoryLabel"
+        }
+      }
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"

package/docs/config-schema.json.md

@@ -26,6 +26,18 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+# `spellCheck` (object)
+
+Properties of the `spellCheck` object:
+
+## `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+## `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
 # `scoringType` (object)
 
 Properties of the `scoringType` object:
@@ -38,6 +50,10 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+# `settingsPanelDisabled` (boolean)
+
+Indicates if the settings panel is not available
+
 # `studentInstructions` (object)
 
 Properties of the `studentInstructions` object:
@@ -62,6 +78,102 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+# `minChoices` (number)
+
+Minimum number of choices
+
+# `maxChoices` (number)
+
+Maximum number of choices
+
+# `choicesPosition` (object)
+
+Properties of the `choicesPosition` object:
+
+## `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+## `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+# `maxCategories` (number)
+
+Maximum number of categories
+
+# `minCategoriesPerRow` (number)
+
+Minimum value of categories per row
+
+# `maxImageWidth` (object)
+
+Properties of the `maxImageWidth` object:
+
+## `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+## `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+## `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+## `choices` (number)
+
+Indicates the max dimension for images in choices
+
+## `rowLabel` (number)
+
+Indicates the max dimension for images in row labels
+
+## `categoryLabel` (number)
+
+Indicates the max dimension for images in category labels
+
+# `maxImageHeight` (object)
+
+Properties of the `maxImageHeight` object:
+
+## `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+## `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+## `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+## `choices` (number)
+
+Indicates the max dimension for images in choices
+
+## `rowLabel` (number)
+
+Indicates the max dimension for images in row labels
+
+## `categoryLabel` (number)
+
+Indicates the max dimension for images in category labels
+
+# `withRubric` (object)
+
+Properties of the `withRubric` object:
+
+## `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+## `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
 # `showPrompt` (boolean)
 
 Determines whether prompt field will be displayed or not
@@ -96,4 +208,32 @@ Indicates if the item has to be displayed in the Settings Panel
 
 ### `label` (string)
 
-Indicates the label for the item that has to be displayed in the Settings Panel
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+## `ConfigureMaxImageDimensionsProp` (object)
+
+Properties of the `ConfigureMaxImageDimensionsProp` object:
+
+### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+### `choices` (number)
+
+Indicates the max dimension for images in choices
+
+### `rowLabel` (number)
+
+Indicates the max dimension for images in row labels
+
+### `categoryLabel` (number)
+
+Indicates the max dimension for images in category labels

package/docs/demo/config.js

@@ -2,7 +2,7 @@ const { model } = require('./generate');
 
 module.exports = {
   elements: {
-    'categorize-element': '../..'
+    'categorize-element': '../..',
   },
-  models: [model('1', 'categorize-element')]
+  models: [model('1', 'categorize-element')],
 };

package/docs/demo/generate.js

@@ -1,7 +1,6 @@
 const E234 = {
   choicesPosition: 'below',
   lockChoiceOrder: false,
-  choicesPerRow: 2,
   choices: [
     {
       content: 'built on board',
@@ -37,8 +36,7 @@ const E234 = {
   categoriesPerRow: 2,
   rationale:
     '<p>Traditional equipment must be carried on board or shipped from Earth. 3D-printed equipment can be built on demand or rebuilt if it gets lost or broken.</p>',
-  prompt:
-    '<p>Drag <span class="relative-emphasis">two</span> phrases into each of the categories.</p>',
+  prompt: '<p>Drag <span class="relative-emphasis">two</span> phrases into each of the categories.</p>',
   partialScoring: true,
   correctResponse: [
     {
@@ -51,8 +49,8 @@ const E234 = {
     },
   ],
 };
+
 // const E236 = {
-//   choicesPerRow: 2,
 //   choices: [
 //     {
 //       id: '0',
@@ -123,7 +121,6 @@ const E234 = {
 //   lockChoiceOrder: false,
 // };
 // const E216 = {
-//   choicesPerRow: 2,
 //   choices: [
 //     {
 //       categoryCount: 1,
@@ -244,7 +241,6 @@ const E234 = {
 //   ],
 //   choicesPosition: 'below',
 //   lockChoiceOrder: false,
-//   choicesPerRow: 2,
 //   choices: [
 //     {
 //       content: '<em>f</em>(<em>x</em>) is increasing',
@@ -304,11 +300,9 @@ exports.model = (id, element) => ({
       categoryCount: 2,
     },
   ],
-  choicesPerRow: 4,
   choicesPosition: 'below',
   choicesLabel: '',
   lockChoiceOrder: true,
-  removeTilesAfterPlacing: false,
   categoriesPerRow: 2,
   categories: [
     {
@@ -336,10 +330,13 @@ exports.model = (id, element) => ({
       alternateResponses: [['id-rosie', 'id-morcov'], ['id-morcov']],
     },
   ],
+  note: 'The answer shown above is the most common correct answer for this item. One or more additional correct answers are also defined, and will also be recognized as correct.',
   rowLabels: ['', ''],
   partialScoring: true,
   feedbackEnabled: true,
   rationaleEnabled: true,
   teacherInstructionsEnabled: true,
   studentInstructionsEnabled: true,
+  toolbarEditorPosition: 'bottom',
+  rubricEnabled: false,
 });

package/docs/demo/index.html

@@ -1 +1 @@
-<categorize-element pie-id="1"></categorize-element>
+<categorize-element pie-id="1"></categorize-element>

package/docs/pie-schema.json

@@ -42,12 +42,6 @@
       },
       "title": "choices"
     },
-    "choicesPerRow": {
-      "description": "The number of columns in which to present the choices",
-      "default": 2,
-      "type": "number",
-      "title": "choicesPerRow"
-    },
     "categoriesPerRow": {
       "description": "The number of columns in which to present the categories",
       "default": 2,
@@ -84,11 +78,6 @@
       "type": "boolean",
       "title": "promptEnabled"
     },
-    "removeTilesAfterPlacing": {
-      "description": "Indicates if the choice, after it is dragged into a category, should be removed from the choices\narea or should remain in place.",
-      "type": "boolean",
-      "title": "removeTilesAfterPlacing"
-    },
     "categories": {
       "description": "The categories in which choices may be placed",
       "type": "array",
@@ -379,6 +368,11 @@
       "type": "boolean",
       "title": "rationaleEnabled"
     },
+    "spellCheckEnabled": {
+      "description": "Indicates if spellcheck is enabled for the author. Default value is true",
+      "type": "boolean",
+      "title": "spellCheckEnabled"
+    },
     "studentInstructionsEnabled": {
       "description": "Indicates if Student Instructions are enabled",
       "type": "boolean",
@@ -389,6 +383,26 @@
       "type": "boolean",
       "title": "teacherInstructionsEnabled"
     },
+    "note": {
+      "description": "Indicates the note for the answer",
+      "type": "string",
+      "title": "note"
+    },
+    "toolbarEditorPosition": {
+      "description": "Indicates the editor's toolbar position which can be 'bottom' or 'top'",
+      "default": ": 'bottom'",
+      "enum": [
+        "bottom",
+        "top"
+      ],
+      "type": "string",
+      "title": "toolbarEditorPosition"
+    },
+    "rubricEnabled": {
+      "description": "Indicates if Rubric is enabled",
+      "type": "boolean",
+      "title": "rubricEnabled"
+    },
     "id": {
       "description": "Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.",
       "type": "string",
@@ -408,6 +422,8 @@
     "id",
     "prompt",
     "rationaleEnabled",
+    "rubricEnabled",
+    "spellCheckEnabled",
     "studentInstructionsEnabled",
     "teacherInstructionsEnabled"
   ],
@@ -428,6 +444,42 @@
         }
       }
     },
+    "ConfigureMaxImageDimensionsProp": {
+      "title": "ConfigureMaxImageDimensionsProp",
+      "type": "object",
+      "properties": {
+        "teacherInstructions": {
+          "description": "Indicates the max dimension for images in teacher instructions",
+          "type": "number",
+          "title": "teacherInstructions"
+        },
+        "prompt": {
+          "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+          "type": "number",
+          "title": "prompt"
+        },
+        "rationale": {
+          "description": "Indicates the max dimension for images in rationale",
+          "type": "number",
+          "title": "rationale"
+        },
+        "choices": {
+          "description": "Indicates the max dimension for images in choices",
+          "type": "number",
+          "title": "choices"
+        },
+        "rowLabel": {
+          "description": "Indicates the max dimension for images in row labels",
+          "type": "number",
+          "title": "rowLabel"
+        },
+        "categoryLabel": {
+          "description": "Indicates the max dimension for images in category labels",
+          "type": "number",
+          "title": "categoryLabel"
+        }
+      }
+    },
     "CategoryChoice": {
       "title": "CategoryChoice",
       "type": "object",

package/docs/pie-schema.json.md

@@ -22,12 +22,6 @@ The xhtml content for the choice
 
 ## `correctResponseCount` (string,number)
 
-# `choicesPerRow` (number)
-
-The number of columns in which to present the choices
-
-Default: `2`
-
 # `categoriesPerRow` (number)
 
 The number of columns in which to present the categories
@@ -59,11 +53,6 @@ The question prompt or item stem
 
 Indicates if the prompt is enabled
 
-# `removeTilesAfterPlacing` (boolean)
-
-Indicates if the choice, after it is dragged into a category, should be removed from the choices
-area or should remain in place.
-
 # `categories` (array, required)
 
 The categories in which choices may be placed
@@ -156,6 +145,10 @@ Indicates if Feedback is enabled
 
 Indicates if Rationale are enabled
 
+# `spellCheckEnabled` (boolean, required)
+
+Indicates if spellcheck is enabled for the author. Default value is true
+
 # `studentInstructionsEnabled` (boolean, required)
 
 Indicates if Student Instructions are enabled
@@ -164,6 +157,25 @@ Indicates if Student Instructions are enabled
 
 Indicates if Teacher Instructions are enabled
 
+# `note` (string)
+
+Indicates the note for the answer
+
+# `toolbarEditorPosition` (string, enum)
+
+Indicates the editor's toolbar position which can be 'bottom' or 'top'
+
+This element must be one of the following enum values:
+
+* `bottom`
+* `top`
+
+Default: `": 'bottom'"`
+
+# `rubricEnabled` (boolean, required)
+
+Indicates if Rubric is enabled
+
 # `id` (string, required)
 
 Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
@@ -190,6 +202,34 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+## `ConfigureMaxImageDimensionsProp` (object)
+
+Properties of the `ConfigureMaxImageDimensionsProp` object:
+
+### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+### `choices` (number)
+
+Indicates the max dimension for images in choices
+
+### `rowLabel` (number)
+
+Indicates the max dimension for images in row labels
+
+### `categoryLabel` (number)
+
+Indicates the max dimension for images in category labels
+
 ## `CategoryChoice` (object)
 
 Properties of the `CategoryChoice` object: