@pie-element/explicit-constructed-response 11.1.0-next.19 → 11.1.1-next.1

package/docs/pie-schema.json.md

@@ -1,814 +0,0 @@
-Model for the @pie-elements/explicit-constructed-response
-
-The schema defines the following properties:
-
-# `choices` (object, required)
-
-* Object with all the available choices for each response area.
-* Keys need to be integers from 0 to n - 1 (where n is the number of areas)
-
-# `displayType` (string, required)
-
-The type of display the container of the pie-ui element will be used
-
-# `markup` (string, required)
-
-The markup for the pie-ui element
-
-# `prompt` (string)
-
-The item stem for the question
-
-# `promptEnabled` (boolean)
-
-Indicates if the prompt is enabled
-
-# `spellCheckEnabled` (boolean, required)
-
-Indicates if spellcheck is enabled for the author. Default value is true
-
-# `playerSpellCheckEnabled` (boolean, required)
-
-Indicates if spellcheck is enabled for the player. Default value is true
-
-# `rationale` (string, required)
-
-Indicates correct answer rationale
-
-# `autoScoring` (string, enum, required)
-
-Indicates auto scoring type
-
-This element must be one of the following enum values:
-
-* `allOrNothing`
-* `partial`
-
-# `studentInstructions` (string)
-
-Indicates student instructions
-
-# `teacherInstructions` (string)
-
-Indicates teacher instructions
-
-# `rubric` (string, required)
-
-Indicates value for rubric
-
-# `rationaleEnabled` (boolean, required)
-
-Indicates if Rationale are enabled
-
-# `studentInstructionsEnabled` (boolean, required)
-
-Indicates if Student Instructions are enabled
-
-# `teacherInstructionsEnabled` (boolean, required)
-
-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'"`
-
-# `maxLengthPerChoice` (array)
-
-Indicates the maximum length for each response area
-
-The object is an array with all elements of the type `number`.
-
-# `rubricEnabled` (boolean, required)
-
-Indicates if Rubric is enabled
-
-# `language` (string)
-
-Indicates the language of the component
-Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX
-
-# `spanishInputEnabled` (boolean)
-
-Whether a control to allow insertion of spanish characters should be displayed
-
-Default: `true`
-
-# `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:
-
-## `EditableHtmlConfigureProp` (object)
-
-Properties of the `EditableHtmlConfigureProp` object:
-
-### `math` (object)
-
-Properties of the `math` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `audio` (object)
-
-Properties of the `audio` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `video` (object)
-
-Properties of the `video` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `image` (object)
-
-Properties of the `image` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `customPlugins` (array)
-
-An array of objects that determine custom plugins.
-A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
-Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `event` (string, required)
-
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-
-#### `iconAlt` (string, required)
-
-The alt for the custom button icon
-
-#### `iconType` (string, required)
-
-The icon type.
-Currently, only "SVG" is supported.
-
-#### `icon` (string, required)
-
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-
-### `blockquote` (object)
-
-Properties of the `blockquote` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `h3` (object)
-
-Properties of the `h3` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `characters` (object)
-
-Properties of the `characters` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `bold` (object)
-
-Properties of the `bold` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `html` (object)
-
-Properties of the `html` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `italic` (object)
-
-Properties of the `italic` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `ol_list` (object)
-
-Properties of the `ol_list` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `redo` (object)
-
-Properties of the `redo` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `strikethrough` (object)
-
-Properties of the `strikethrough` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `sub` (object)
-
-Properties of the `sub` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `sup` (object)
-
-Properties of the `sup` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `table` (object)
-
-Properties of the `table` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `ul_list` (object)
-
-Properties of the `ul_list` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `underline` (object)
-
-Properties of the `underline` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `undo` (object)
-
-Properties of the `undo` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-## `EditableHtmlButtonConfigure` (object)
-
-Properties of the `EditableHtmlButtonConfigure` object:
-
-### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-## `CustomPlugin` (object)
-
-Properties of the `CustomPlugin` object:
-
-### `event` (string, required)
-
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-
-### `iconAlt` (string, required)
-
-The alt for the custom button icon
-
-### `iconType` (string, required)
-
-The icon type.
-Currently, only "SVG" is supported.
-
-### `icon` (string, required)
-
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-
-## `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
-
-## `EditableHtmlPluginConfigureRequired` (object)
-
-Properties of the `EditableHtmlPluginConfigureRequired` object:
-
-### `inputConfiguration` (object)
-
-Properties of the `inputConfiguration` object:
-
-#### `math` (object)
-
-Properties of the `math` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `audio` (object)
-
-Properties of the `audio` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `video` (object)
-
-Properties of the `video` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `image` (object)
-
-Properties of the `image` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `customPlugins` (array)
-
-An array of objects that determine custom plugins.
-A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
-Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-##### `event` (string, required)
-
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-
-##### `iconAlt` (string, required)
-
-The alt for the custom button icon
-
-##### `iconType` (string, required)
-
-The icon type.
-Currently, only "SVG" is supported.
-
-##### `icon` (string, required)
-
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-
-#### `blockquote` (object)
-
-Properties of the `blockquote` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `h3` (object)
-
-Properties of the `h3` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `characters` (object)
-
-Properties of the `characters` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `bold` (object)
-
-Properties of the `bold` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `html` (object)
-
-Properties of the `html` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `italic` (object)
-
-Properties of the `italic` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `ol_list` (object)
-
-Properties of the `ol_list` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `redo` (object)
-
-Properties of the `redo` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `strikethrough` (object)
-
-Properties of the `strikethrough` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `sub` (object)
-
-Properties of the `sub` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `sup` (object)
-
-Properties of the `sup` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `table` (object)
-
-Properties of the `table` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `ul_list` (object)
-
-Properties of the `ul_list` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `underline` (object)
-
-Properties of the `underline` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `undo` (object)
-
-Properties of the `undo` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `required` (boolean)
-
-Indicates if the item is required and the value cannot be empty
-
-### `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
-
-## `EditableHtmlPluginConfigure` (object)
-
-Properties of the `EditableHtmlPluginConfigure` object:
-
-### `inputConfiguration` (object)
-
-Properties of the `inputConfiguration` object:
-
-#### `math` (object)
-
-Properties of the `math` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `audio` (object)
-
-Properties of the `audio` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `video` (object)
-
-Properties of the `video` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `image` (object)
-
-Properties of the `image` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `customPlugins` (array)
-
-An array of objects that determine custom plugins.
-A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
-Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-##### `event` (string, required)
-
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-
-##### `iconAlt` (string, required)
-
-The alt for the custom button icon
-
-##### `iconType` (string, required)
-
-The icon type.
-Currently, only "SVG" is supported.
-
-##### `icon` (string, required)
-
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-
-#### `blockquote` (object)
-
-Properties of the `blockquote` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `h3` (object)
-
-Properties of the `h3` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `characters` (object)
-
-Properties of the `characters` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `bold` (object)
-
-Properties of the `bold` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `html` (object)
-
-Properties of the `html` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `italic` (object)
-
-Properties of the `italic` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `ol_list` (object)
-
-Properties of the `ol_list` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `redo` (object)
-
-Properties of the `redo` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `strikethrough` (object)
-
-Properties of the `strikethrough` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `sub` (object)
-
-Properties of the `sub` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `sup` (object)
-
-Properties of the `sup` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `table` (object)
-
-Properties of the `table` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `ul_list` (object)
-
-Properties of the `ul_list` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `underline` (object)
-
-Properties of the `underline` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `undo` (object)
-
-Properties of the `undo` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `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
-
-## `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
-
-## `ConfigureMathMLProp` (object)
-
-Properties of the `ConfigureMathMLProp` object:
-
-### `mmlOutput` (number)
-
-Indicates if model should have mathML output instead of latex
-
-### `mmlEditing` (number)
-
-Indicates if mathML that's already in model should be editable
-
-## `ConfigurePropWithEnabled` (object)
-
-Properties of the `ConfigurePropWithEnabled` object:
-
-### `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)
-
-### `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
-
-## `ConfigureLanguageOptionsProp` (object)
-
-Properties of the `ConfigureLanguageOptionsProp` object:
-
-### `value` (string, required)
-
-Value of the language option
-
-### `label` (string, required)
-
-Label of the language option
-
-## `Choice` (object)
-
-Properties of the `Choice` object:
-
-### `value` (string, required)
-
-The value for the choice
-
-### `label` (string, required)
-
-The label of the choice