@pie-element/ebsr 6.6.2 → 6.6.3-next.1016

package/configure/node_modules/@pie-element/multiple-choice/docs/pie-schema.json

@@ -0,0 +1,338 @@
+{
+  "description": "Model for the Choice Interaction",
+  "additionalProperties": false,
+  "type": "object",
+  "properties": {
+    "choiceMode": {
+      "description": "Indicates the choices are single or multiple selection",
+      "enum": [
+        "checkbox",
+        "radio"
+      ],
+      "type": "string",
+      "title": "choiceMode"
+    },
+    "choicePrefix": {
+      "description": "What key should be displayed before choices. If undefined no  key will be displayed.",
+      "default": ": 'letters'",
+      "enum": [
+        "letters",
+        "numbers"
+      ],
+      "type": "string",
+      "title": "choicePrefix"
+    },
+    "choices": {
+      "description": "The choice options for the question",
+      "type": "array",
+      "items": {
+        "title": "Choice",
+        "type": "object",
+        "properties": {
+          "correct": {
+            "description": "Indicates if the choice is correct",
+            "type": "boolean",
+            "title": "correct"
+          },
+          "value": {
+            "description": "the value that will be stored if this choice is selected",
+            "type": "string",
+            "title": "value"
+          },
+          "label": {
+            "description": "the text label that will be presented to the user for this choice",
+            "type": "string",
+            "title": "label"
+          },
+          "feedback": {
+            "description": "The type of feedback to use:\n   `default` = a standard feedback message\n   `custom` = a customized feedback message",
+            "title": "Feedback",
+            "type": "object",
+            "properties": {
+              "type": {
+                "default": "default",
+                "enum": [
+                  "custom",
+                  "default",
+                  "none"
+                ],
+                "type": "string",
+                "title": "type"
+              },
+              "value": {
+                "description": "Value for feedback",
+                "type": "string",
+                "title": "value"
+              },
+              "custom": {
+                "description": "Custom value for feedback",
+                "type": "string",
+                "title": "custom"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "rationale": {
+            "description": "Rationale for the Choice",
+            "type": "string",
+            "title": "rationale"
+          }
+        },
+        "required": [
+          "label",
+          "value"
+        ]
+      },
+      "title": "choices"
+    },
+    "prompt": {
+      "description": "The question prompt or item stem",
+      "type": "string",
+      "title": "prompt"
+    },
+    "promptEnabled": {
+      "description": "Determines if prompt should show",
+      "type": "boolean",
+      "title": "promptEnabled"
+    },
+    "choicesLayout": {
+      "description": "Indicates the layout of choices for player",
+      "default": ": 'vertical'",
+      "enum": [
+        "grid",
+        "horizontal",
+        "vertical"
+      ],
+      "type": "string",
+      "title": "choicesLayout"
+    },
+    "gridColumns": {
+      "description": "Indicates the number of columns for the grid layout",
+      "default": ": 2",
+      "type": "number",
+      "title": "gridColumns"
+    },
+    "toolbarEditorPosition": {
+      "description": "Indicates the editor's toolbar position which can be 'bottom' or 'top'",
+      "default": ": 'bottom'",
+      "enum": [
+        "bottom",
+        "top"
+      ],
+      "type": "string",
+      "title": "toolbarEditorPosition"
+    },
+    "lockChoiceOrder": {
+      "description": "Indicates the order of choices should be randomly ordered when presented to user",
+      "type": "boolean",
+      "title": "lockChoiceOrder"
+    },
+    "partialScoring": {
+      "description": "Indicates that the item should use partial scoring",
+      "type": "boolean",
+      "title": "partialScoring"
+    },
+    "scoringType": {
+      "description": "Indicates scoring type",
+      "enum": [
+        "auto",
+        "rubric"
+      ],
+      "type": "string",
+      "title": "scoringType"
+    },
+    "studentInstructions": {
+      "description": "Indicates student instructions",
+      "type": "string",
+      "title": "studentInstructions"
+    },
+    "teacherInstructions": {
+      "description": "Indicates teacher instructions",
+      "type": "string",
+      "title": "teacherInstructions"
+    },
+    "feedbackEnabled": {
+      "description": "Indicates if feedback is enabled",
+      "type": "boolean",
+      "title": "feedbackEnabled"
+    },
+    "rationaleEnabled": {
+      "description": "Indicates if Rationale are enabled",
+      "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",
+      "title": "studentInstructionsEnabled"
+    },
+    "teacherInstructionsEnabled": {
+      "description": "Indicates if Teacher Instructions are enabled",
+      "type": "boolean",
+      "title": "teacherInstructionsEnabled"
+    },
+    "accessibilityLabelsEnabled": {
+      "description": "Indicates if Accessibility Labels are enabled",
+      "type": "boolean",
+      "title": "accessibilityLabelsEnabled"
+    },
+    "id": {
+      "description": "Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.",
+      "type": "string",
+      "title": "id"
+    },
+    "element": {
+      "description": "The html Element tag name",
+      "type": "string",
+      "title": "element"
+    }
+  },
+  "required": [
+    "accessibilityLabelsEnabled",
+    "choices",
+    "element",
+    "feedbackEnabled",
+    "id",
+    "rationaleEnabled",
+    "spellCheckEnabled",
+    "studentInstructionsEnabled",
+    "teacherInstructionsEnabled"
+  ],
+  "definitions": {
+    "ConfigureProp": {
+      "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"
+        }
+      }
+    },
+    "ConfigurePropWithEnabled": {
+      "title": "ConfigurePropWithEnabled",
+      "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"
+        },
+        "enabled": {
+          "description": "Indicates the value of the item if it affects config-ui\n(eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)",
+          "type": "boolean",
+          "title": "enabled"
+        }
+      }
+    },
+    "Choice": {
+      "title": "Choice",
+      "type": "object",
+      "properties": {
+        "correct": {
+          "description": "Indicates if the choice is correct",
+          "type": "boolean",
+          "title": "correct"
+        },
+        "value": {
+          "description": "the value that will be stored if this choice is selected",
+          "type": "string",
+          "title": "value"
+        },
+        "label": {
+          "description": "the text label that will be presented to the user for this choice",
+          "type": "string",
+          "title": "label"
+        },
+        "feedback": {
+          "description": "The type of feedback to use:\n   `default` = a standard feedback message\n   `custom` = a customized feedback message",
+          "title": "Feedback",
+          "type": "object",
+          "properties": {
+            "type": {
+              "default": "default",
+              "enum": [
+                "custom",
+                "default",
+                "none"
+              ],
+              "type": "string",
+              "title": "type"
+            },
+            "value": {
+              "description": "Value for feedback",
+              "type": "string",
+              "title": "value"
+            },
+            "custom": {
+              "description": "Custom value for feedback",
+              "type": "string",
+              "title": "custom"
+            }
+          },
+          "required": [
+            "type"
+          ]
+        },
+        "rationale": {
+          "description": "Rationale for the Choice",
+          "type": "string",
+          "title": "rationale"
+        }
+      },
+      "required": [
+        "label",
+        "value"
+      ]
+    },
+    "Feedback": {
+      "description": "The type of feedback to use:\n   `default` = a standard feedback message\n   `custom` = a customized feedback message",
+      "title": "Feedback",
+      "type": "object",
+      "properties": {
+        "type": {
+          "default": "default",
+          "enum": [
+            "custom",
+            "default",
+            "none"
+          ],
+          "type": "string",
+          "title": "type"
+        },
+        "value": {
+          "description": "Value for feedback",
+          "type": "string",
+          "title": "value"
+        },
+        "custom": {
+          "description": "Custom value for feedback",
+          "type": "string",
+          "title": "custom"
+        }
+      },
+      "required": [
+        "type"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/configure/node_modules/@pie-element/multiple-choice/docs/pie-schema.json.md

@@ -0,0 +1,274 @@
+Model for the Choice Interaction
+
+The schema defines the following properties:
+
+# `choiceMode` (string, enum)
+
+Indicates the choices are single or multiple selection
+
+This element must be one of the following enum values:
+
+* `checkbox`
+* `radio`
+
+# `choicePrefix` (string, enum)
+
+What key should be displayed before choices. If undefined no  key will be displayed.
+
+This element must be one of the following enum values:
+
+* `letters`
+* `numbers`
+
+Default: `": 'letters'"`
+
+# `choices` (array, required)
+
+The choice options for the question
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+## `correct` (boolean)
+
+Indicates if the choice is correct
+
+## `value` (string, required)
+
+the value that will be stored if this choice is selected
+
+## `label` (string, required)
+
+the text label that will be presented to the user for this choice
+
+## `feedback` (object)
+
+The type of feedback to use:
+   `default` = a standard feedback message
+   `custom` = a customized feedback message
+
+Properties of the `feedback` object:
+
+### `type` (string, enum, required)
+
+This element must be one of the following enum values:
+
+* `custom`
+* `default`
+* `none`
+
+Default: `"default"`
+
+### `value` (string)
+
+Value for feedback
+
+### `custom` (string)
+
+Custom value for feedback
+
+## `rationale` (string)
+
+Rationale for the Choice
+
+# `prompt` (string)
+
+The question prompt or item stem
+
+# `promptEnabled` (boolean)
+
+Determines if prompt should show
+
+# `choicesLayout` (string, enum)
+
+Indicates the layout of choices for player
+
+This element must be one of the following enum values:
+
+* `grid`
+* `horizontal`
+* `vertical`
+
+Default: `": 'vertical'"`
+
+# `gridColumns` (number)
+
+Indicates the number of columns for the grid layout
+
+Default: `": 2"`
+
+# `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'"`
+
+# `lockChoiceOrder` (boolean)
+
+Indicates the order of choices should be randomly ordered when presented to user
+
+# `partialScoring` (boolean)
+
+Indicates that the item should use partial scoring
+
+# `scoringType` (string, enum)
+
+Indicates scoring type
+
+This element must be one of the following enum values:
+
+* `auto`
+* `rubric`
+
+# `studentInstructions` (string)
+
+Indicates student instructions
+
+# `teacherInstructions` (string)
+
+Indicates teacher instructions
+
+# `feedbackEnabled` (boolean, required)
+
+Indicates if feedback is enabled
+
+# `rationaleEnabled` (boolean, required)
+
+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
+
+# `teacherInstructionsEnabled` (boolean, required)
+
+Indicates if Teacher Instructions are enabled
+
+# `accessibilityLabelsEnabled` (boolean, required)
+
+Indicates if Accessibility Labels are enabled
+
+# `id` (string, required)
+
+Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
+
+# `element` (string, required)
+
+The html Element tag name
+
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `ConfigureProp` (object)
+
+Properties of the `ConfigureProp` 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
+
+## `ConfigurePropWithEnabled` (object)
+
+Properties of the `ConfigurePropWithEnabled` 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
+
+### `enabled` (boolean)
+
+Indicates the value of the item if it affects config-ui
+(eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
+
+## `Choice` (object)
+
+Properties of the `Choice` object:
+
+### `correct` (boolean)
+
+Indicates if the choice is correct
+
+### `value` (string, required)
+
+the value that will be stored if this choice is selected
+
+### `label` (string, required)
+
+the text label that will be presented to the user for this choice
+
+### `feedback` (object)
+
+The type of feedback to use:
+   `default` = a standard feedback message
+   `custom` = a customized feedback message
+
+Properties of the `feedback` object:
+
+#### `type` (string, enum, required)
+
+This element must be one of the following enum values:
+
+* `custom`
+* `default`
+* `none`
+
+Default: `"default"`
+
+#### `value` (string)
+
+Value for feedback
+
+#### `custom` (string)
+
+Custom value for feedback
+
+### `rationale` (string)
+
+Rationale for the Choice
+
+## `Feedback` (object)
+
+The type of feedback to use:
+   `default` = a standard feedback message
+   `custom` = a customized feedback message
+
+Properties of the `Feedback` object:
+
+### `type` (string, enum, required)
+
+This element must be one of the following enum values:
+
+* `custom`
+* `default`
+* `none`
+
+Default: `"default"`
+
+### `value` (string)
+
+Value for feedback
+
+### `custom` (string)
+
+Custom value for feedback