@pie-element/math-templated 7.1.1-next.11 → 7.1.1-next.13

package/docs/pie-schema.json.md

@@ -1,894 +0,0 @@
-Model for the @pie-elements/math-templated
-
-The schema defines the following properties:
-
-# `markup` (string, required)
-
-Indicates markup value
-
-# `prompt` (string, required)
-
-Indicates prompt value
-
-# `promptEnabled` (boolean, required)
-
-Indicates if Prompt is enabled
-
-# `teacherInstructionsEnabled` (boolean, required)
-
-Indicates if Teacher Instructions are enabled
-
-# `rationale` (string, required)
-
-Indicates rationale value
-
-# `rationaleEnabled` (boolean, required)
-
-Indicates if Rationale is enabled
-
-# `spellCheckEnabled` (boolean, required)
-
-Indicates if Spell Check is enabled
-
-# `playerSpellCheckEnabled` (boolean, required)
-
-Indicates if Player Spell Check is enabled
-
-# `responses` (array, required)
-
-Array of all responses
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-## `allowTrailingZeros` (boolean, required)
-
-Indicates the allowance of trailing zeros in expressions
-
-Default: `"is false"`
-
-## `answer` (string, required)
-
-The value for the response's answer
-
-## `id` (string, required)
-
-The id for the response
-
-## `validation` (string, enum, required)
-
-Indicates what type of validation should be applied on the response
-
-This element must be one of the following enum values:
-
-* `literal`
-* `symbolic`
-
-Default: `"is literal"`
-
-## `ignoreOrder` (boolean, required)
-
-Indicates if the order of expression elements in literal validation can be ignore
-
-Default: `"is false"`
-
-## `alternates` (object, required)
-
-For validation type = literal, alternates represents
-an object with some alternatives for the correct answers
-
-# `element` (string, required)
-
-The html Element tag name
-
-# `equationEditor` (, enum, required)
-
-Indicates what type of editor should be displayed for all the possible responses
-1 for Grade 1 - 2
-3 for Grade 3 - 5
-6 for Grade 6 - 7
-8 for Grade 8 - HS
-non-negative-integers
-integers
-decimals
-fractions
-geometry
-advanced-algebra
-statistics
-
-This element must be one of the following enum values:
-
-* `1`
-* `3`
-* `6`
-* `8`
-* `advanced-algebra`
-* `decimals`
-* `fractions`
-* `geometry`
-* `integers`
-* `item-authoring`
-* `non-negative-integers`
-* `statistics`
-
-Default: `"- item-authoring"`
-
-# `ignoreOrderDefault` (boolean, required)
-
-Indicates the default value for ignoreOrder, in case that it's not set
-
-Default: `"is false"`
-
-# `allowTrailingZerosDefault` (boolean, required)
-
-Indicates the default value for allowTrailingZeros, in case that it's not set
-
-Default: `"is false"`
-
-# `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'"`
-
-# `validationDefault` (string, enum, required)
-
-Indicates what type of validation should be applied on the response
-
-This element must be one of the following enum values:
-
-* `literal`
-* `symbolic`
-
-Default: `"is literal"`
-
-# `id` (string, required)
-
-Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
-
----
-
-# Sub Schemas
-
-The schema defines the following additional types:
-
-## `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
-
-## `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
-
-## `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.
-
-## `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
-
-## `ConfigureLanguageOptionsProp` (object)
-
-Properties of the `ConfigureLanguageOptionsProp` object:
-
-### `value` (string, required)
-
-Value of the language option
-
-### `label` (string, required)
-
-Label of the language option
-
-## `Response` (object)
-
-Properties of the `Response` object:
-
-### `allowTrailingZeros` (boolean, required)
-
-Indicates the allowance of trailing zeros in expressions
-
-Default: `"is false"`
-
-### `answer` (string, required)
-
-The value for the response's answer
-
-### `id` (string, required)
-
-The id for the response
-
-### `validation` (string, enum, required)
-
-Indicates what type of validation should be applied on the response
-
-This element must be one of the following enum values:
-
-* `literal`
-* `symbolic`
-
-Default: `"is literal"`
-
-### `ignoreOrder` (boolean, required)
-
-Indicates if the order of expression elements in literal validation can be ignore
-
-Default: `"is false"`
-
-### `alternates` (object, required)
-
-For validation type = literal, alternates represents
-an object with some alternatives for the correct answers
-
-## `Alternate` (object)
-
-Properties of the `Alternate` object:
-
-### `id` (number, required)
-
-The id for the alternative response
-
-### `answer` (string, required)
-
-The value for the alternative response