npm - @pie-element/fraction-model - Versions diffs - 6.1.0-next.28 → 6.1.1-next.0 - Mend

@pie-element/fraction-model 6.1.0-next.28 → 6.1.1-next.0

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 (180) hide show

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

@@ -1,639 +0,0 @@
-The schema defines the following properties:
-# `correctResponse` (array, required)
-Array of ResponseObject for correct response
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-## `id` (number, required)
-Indicates the response id for bar or pie model
-## `value` (number, required)
-Indicates the selected response sector for model value
-# `title` (string, required)
-The title prompt of the item
-# `prompt` (string, required)
-The question prompt or item stem
-# `modelTypeSelected` (string, enum)
-Indicates if the model type should be Bar or Pie model
-This element must be one of the following enum values:
-* `bar`
-* `pie`
-Default: `": 'bar'"`
-# `maxModelSelected` (number)
-Indicates max no of models to be selected
-Default: `": 1"`
-# `partsPerModel` (number)
-Indicates parts per model to be selected
-Default: `": 5"`
-# `allowedStudentConfig` (boolean)
-Indicates if student can configure no of models and parts per model
-Default: `": false"`
-# `showGraphLabels` (boolean)
-Determines if graph labels visible or not
-Default: `": false"`
-# `language` (string)
-Indicates the language of the component
-Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX
-# `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.
-## `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
-## `FractionModelOptionsConfigure` (object)
-Properties of the `FractionModelOptionsConfigure` object:
-### `maxOfModel` (object)
-Properties of the `maxOfModel` object:
-#### `min` (number)
-Indicates the min value for number model
-#### `max` (number)
-Indicates the max value for number model
-#### `default` (number)
-Indicates the default value for number model
-### `partsPerModel` (object)
-Properties of the `partsPerModel` object:
-#### `min` (number)
-Indicates the min value for number model
-#### `max` (number)
-Indicates the max value for number model
-#### `default` (number)
-Indicates the default value for number model
-### `modelTypeChoices` (array)
-Indicates the model types of item
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-#### `value` (string, required)
-Indicates the value for model choice
-#### `label` (string, required)
-Indicates the label for model choice
-## `ModelConfig` (object)
-Properties of the `ModelConfig` object:
-### `min` (number)
-Indicates the min value for number model
-### `max` (number)
-Indicates the max value for number model
-### `default` (number)
-Indicates the default value for number model
-## `ChoiceConfig` (object)
-Properties of the `ChoiceConfig` object:
-### `value` (string, required)
-Indicates the value for model choice
-### `label` (string, required)
-Indicates the label for model choice
-## `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
-## `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
-## `ResponseObject` (object)
-Model for the @pie-elements/fraction-model
-Properties of the `ResponseObject` object:
-### `id` (number, required)
-Indicates the response id for bar or pie model
-### `value` (number, required)
-Indicates the selected response sector for model value