npm - @pie-element/categorize - Versions diffs - 13.1.0-next.28 → 13.1.1-next.1 - Mend

@pie-element/categorize 13.1.0-next.28 → 13.1.1-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (252) hide show

package/docs/pie-schema.json.md DELETED Viewed

@@ -1,1046 +0,0 @@
-Pie Model Object for @pie-elements/categorize
-The schema defines the following properties:
-# `allowMaxChoicesPerCategory` (boolean, required)
-Indicates if author has the possibility to set maxChoicesPerCategory
-# `choices` (array, required)
-The available choices
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-## `id` (string, required)
-Identifier for the choice
-## `content` (string, required)
-The xhtml content for the choice
-## `categoryCount` (string,number)
-## `correctResponseCount` (string,number)
-# `categoriesPerRow` (number)
-The number of columns in which to present the categories
-Default: `2`
-# `choicesPosition` (string, enum)
-This element must be one of the following enum values:
-* `above`
-* `below`
-* `left`
-* `right`
-# `choicesLabel` (string)
-Label to be displayed for the choices
-# `lockChoiceOrder` (boolean)
-Should the choices be shuffled or not
-# `prompt` (string, required)
-The question prompt or item stem
-# `promptEnabled` (boolean)
-Indicates if the prompt is enabled
-# `categories` (array, required)
-The categories in which choices may be placed
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-## `id` (string, required)
-Identifier for the category
-## `label` (string, required)
-The label to display with the category.
-## `choices` (array, required)
-The choices presented in this category
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-### `id` (string, required)
-Identifier for the choice
-### `content` (string, required)
-The xhtml content for the choice
-### `categoryCount` (string,number)
-### `correctResponseCount` (string,number)
-# `correctResponse` (array)
-The defintion of the correct response to the question
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-## `category` (string, required)
-The identifier for the category
-## `choices` (array, required)
-Array of identifiers for the choices that belong in this category
-The object is an array with all elements of the type `string`.
-## `alternateResponses` (array)
-Array of alternatives correct choices
-The object is an array with all elements of the type `array`.
-# `feedback` (object)
-Properties of the `feedback` object:
-## `correct` (, required)
-Indicates the configuration for feedback when answer is correct
-## `incorrect` (, required)
-Indicates the configuration for feedback when answer is incorrect
-## `partial`
-Indicates the configuration for feedback when answer is partially correct
-# `maxChoicesPerCategory` (number, required)
-Indicates the maximum number of choices from a category
-# `rationale` (string)
-Indicates the value for rationale
-# `partialScoring` (boolean)
-Indicates if partial scoring is 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
-# `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'"`
-# `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
-# `maxAnswerChoices` (number)
-Maximum number of choices
-# `fontSizeFactor` (number)
-Indicates font size adjustment factor
-# `autoplayAudioEnabled` (boolean)
-Indicates if the audio for the prompt should autoplay
-# `completeAudioEnabled` (boolean)
-Indicates if the audio should reach the end before the item can be marked as 'complete'
-# `customAudioButton` (object)
-Indicates if the audio should be replaced with a custom audio button
-  playImage: image url for the play state
-  pauseImage: image url for the pause state
-Properties of the `customAudioButton` object:
-## `playImage` (string, required)
-## `pauseImage` (string, required)
-# `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
-## `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
-## `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
-## `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
-## `CategoryChoice` (object)
-Properties of the `CategoryChoice` object:
-### `id` (string, required)
-Identifier for the choice
-### `content` (string, required)
-The xhtml content for the choice
-### `categoryCount` (string,number)
-### `correctResponseCount` (string,number)
-## `ChoicesPosition` (string)
-## `Category` (object)
-Properties of the `Category` object:
-### `id` (string, required)
-Identifier for the category
-### `label` (string, required)
-The label to display with the category.
-### `choices` (array, required)
-The choices presented in this category
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-#### `id` (string, required)
-Identifier for the choice
-#### `content` (string, required)
-The xhtml content for the choice
-#### `categoryCount` (string,number)
-#### `correctResponseCount` (string,number)
-## `CategoryCorrectResponse` (object)
-Properties of the `CategoryCorrectResponse` object:
-### `category` (string, required)
-The identifier for the category
-### `choices` (array, required)
-Array of identifiers for the choices that belong in this category
-The object is an array with all elements of the type `string`.
-### `alternateResponses` (array)
-Array of alternatives correct choices
-The object is an array with all elements of the type `array`.
-## `ComplexFeedbackType` (object)
-Properties of the `ComplexFeedbackType` object:
-### `correct` (, required)
-Indicates the configuration for feedback when answer is correct
-### `incorrect` (, required)
-Indicates the configuration for feedback when answer is incorrect
-### `partial`
-Indicates the configuration for feedback when answer is partially correct
-## `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
-## `CustomFeedbackType` (object)
-Properties of the `CustomFeedbackType` object:
-### `type` (string, enum, required)
-Indicates the feedback type
-This element must be one of the following enum values:
-* `custom`
-### `custom` (string, required)
-Indicates the feedback custom value