@pie-element/extended-text-entry 15.1.2-next.2 → 15.1.2

package/docs/pie-schema.json.md

@@ -0,0 +1,717 @@
+Model for the @pie-elements/extended-text-entry Interaction
+
+The schema defines the following properties:
+
+# `dimensions` (object, required)
+
+Properties of the `dimensions` object:
+
+## `width` (string)
+
+Width the editor should take. USE CSS-style definition.
+
+## `height` (string)
+
+Height the editor should take. USE CSS-style definition.
+
+# `equationEditor` (string, enum)
+
+Indicates if equation editor is enabled
+
+This element must be one of the following enum values:
+
+* `Grade 1 - 2`
+* `Grade 3 - 5`
+* `Grade 6 - 7`
+* `Grade 8 - HS`
+* `advanced-algebra`
+* `geometry`
+* `miscellaneous`
+* `statistics`
+
+# `feedback` (object)
+
+Properties of the `feedback` object:
+
+## `type` (string, enum, required)
+
+Indicates the feedback type
+
+This element must be one of the following enum values:
+
+* `default`
+* `none`
+
+## `default` (string)
+
+Indicates the feedback value
+
+# `mathInput` (boolean)
+
+Whether a control to allow insertion of math forumulas should be displayed
+
+Default: `false`
+
+# `spanishInput` (boolean)
+
+Whether a control to allow insertion of spanish characters should be displayed
+
+Default: `false`
+
+# `specialInput` (boolean)
+
+Whether a control to allow insertion of special characters should be displayed
+
+Default: `false`
+
+# `multiple` (boolean)
+
+Indicates if multiple parts are enabled
+
+# `prompt` (string)
+
+The question prompt
+
+# `promptEnabled` (boolean)
+
+Indicates if the prompt is enabled
+
+# `studentInstructions` (string)
+
+Indicates student instructions
+
+# `teacherInstructions` (string)
+
+Indicates teacher instructions
+
+# `annotationsEnabled` (boolean)
+
+Indicates if the annotations are enabled
+
+# `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
+
+# `playerSpellCheckDisabled` (boolean, required)
+
+Indicates if spellcheck is disabled for the player. Default value is true
+
+# `studentInstructionsEnabled` (boolean, required)
+
+Indicates if Student Instructions are enabled
+
+# `teacherInstructionsEnabled` (boolean, required)
+
+Indicates if Teacher Instructions are enabled
+
+# `toolbarEditorPosition` (string, enum)
+
+This element must be one of the following enum values:
+
+* `bottom`
+* `top`
+
+# `predefinedAnnotations` (array)
+
+Indicates the predefined annotations for the annotation menu
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+## `label` (string, required)
+
+Indicates the value displayed in the annotation button
+
+## `text` (string, required)
+
+Indicates the annotation value
+
+## `type` (string, enum, required)
+
+Indicates the type of the annotation
+
+This element must be one of the following enum values:
+
+* `negative`
+* `positive`
+
+# `playersToolbarPosition` (string, enum)
+
+Indicates the editor's toolbar position for the player, 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.
+
+# `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:
+
+### `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
+
+## `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
+
+## `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.
+
+## `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
+
+## `ConfigureWithForceProp` (object)
+
+Properties of the `ConfigureWithForceProp` object:
+
+### `forceEnabled` (boolean)
+
+Indicates the value for the toggle;
+if true:
+- this property will not be visible in Settings Panel (settings will become automatically false)
+- the model property afferent to it will become automatically false
+
+### `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
+
+## `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
+
+## `Dimensions` (object)
+
+Properties of the `Dimensions` object:
+
+### `width` (string)
+
+Width the editor should take. USE CSS-style definition.
+
+### `height` (string)
+
+Height the editor should take. USE CSS-style definition.
+
+## `DefaultFeedbackType` (object)
+
+Properties of the `DefaultFeedbackType` object:
+
+### `type` (string, enum, required)
+
+Indicates the feedback type
+
+This element must be one of the following enum values:
+
+* `default`
+* `none`
+
+### `default` (string)
+
+Indicates the feedback value
+
+## `PredefinedAnnotation` (object)
+
+Properties of the `PredefinedAnnotation` object:
+
+### `label` (string, required)
+
+Indicates the value displayed in the annotation button
+
+### `text` (string, required)
+
+Indicates the annotation value
+
+### `type` (string, enum, required)
+
+Indicates the type of the annotation
+
+This element must be one of the following enum values:
+
+* `negative`
+* `positive`