@pie-element/passage 2.15.1-next.12 → 2.15.1-next.3

package/docs/pie-schema.json.md

@@ -12,42 +12,10 @@ The array object has the following properties:
 
 The title of the passage
 
-## `subtitle` (string)
-
-The subtitle of the passage
-
-## `author` (string)
-
-The author of the passage
-
 ## `text` (string, required)
 
 The content of the passage
 
-## `teacherInstructions` (string)
-
-Indicates teacher instructions
-
-# `teacherInstructionsEnabled` (boolean, required)
-
-Indicates if Teacher Instructions are enabled
-
-# `titleEnabled` (boolean, required)
-
-Indicates if title is enabled
-
-# `subtitleEnabled` (boolean, required)
-
-Indicates if subtitle is enabled
-
-# `textEnabled` (boolean, required)
-
-Indicates if text is enabled
-
-# `authorEnabled` (boolean, required)
-
-Indicates if author is enabled
-
 # `id` (string, required)
 
 Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
@@ -62,240 +30,6 @@ The html Element tag name
 
 The schema defines the following additional types:
 
-## `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.
-
-### `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.
-
-## `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
-
-## `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
-
 ## `Passage` (object)
 
 Properties of the `Passage` object:
@@ -304,18 +38,6 @@ Properties of the `Passage` object:
 
 The title of the passage
 
-### `subtitle` (string)
-
-The subtitle of the passage
-
-### `author` (string)
-
-The author of the passage
-
 ### `text` (string, required)
 
-The content of the passage
-
-### `teacherInstructions` (string)
-
-Indicates teacher instructions
+The content of the passage