npm - @pie-element/likert - Versions diffs - 4.1.1 → 4.1.2-next.0 - Mend

@pie-element/likert 4.1.1 → 4.1.2-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 (182) hide show

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

@@ -1,711 +0,0 @@
-Model for the Likert Interaction
-The schema defines the following properties:
-# `likertScale` (string, enum)
-Indicates the likert scale
-This element must be one of the following enum values:
-* `likert3`
-* `likert5`
-* `likert7`
-# `likertType` (string, enum)
-Indicates the likert type
-This element must be one of the following enum values:
-* `agreement`
-* `frequency`
-* `importance`
-* `like`
-* `likelihood`
-* `yesNo`
-# `likertOrientation` (string, enum)
-Indicates the likert type
-This element must be one of the following enum values:
-* `horizontal`
-* `vertical`
-# `choices` (array, required)
-The choice options for the question
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-## `value` (string, required)
-the value that will be stored if this likert choice is selected
-## `label` (string, required)
-the text label that will be presented to the user for this likert choice
-# `teacherInstructionsEnabled` (boolean, required)
-Indicates if Teacher Instructions are enabled
-# `spellCheckEnabled` (boolean, required)
-Indicates if spellcheck is enabled for the author. Default value is 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:
-## `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
-## `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
-## `LikertChoice` (object)
-Properties of the `LikertChoice` object:
-### `value` (string, required)
-the value that will be stored if this likert choice is selected
-### `label` (string, required)
-the text label that will be presented to the user for this likert choice