@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
  1. package/dist/author/defaults.d.ts +223 -0
  2. package/dist/author/defaults.js +170 -0
  3. package/dist/author/design/builder.d.ts +10 -0
  4. package/dist/author/design/builder.js +24 -0
  5. package/dist/author/design/buttons.d.ts +28 -0
  6. package/dist/author/design/buttons.js +36 -0
  7. package/dist/author/design/categories/RowLabel.d.ts +23 -0
  8. package/dist/author/design/categories/RowLabel.js +47 -0
  9. package/dist/author/design/categories/alternateResponses.d.ts +31 -0
  10. package/dist/author/design/categories/alternateResponses.js +62 -0
  11. package/dist/author/design/categories/category.d.ts +44 -0
  12. package/dist/author/design/categories/category.js +98 -0
  13. package/dist/author/design/categories/choice-preview.d.ts +25 -0
  14. package/dist/author/design/categories/choice-preview.js +60 -0
  15. package/dist/author/design/categories/droppable-placeholder.d.ts +11 -0
  16. package/dist/author/design/categories/droppable-placeholder.js +71 -0
  17. package/dist/author/design/categories/index.d.ts +41 -0
  18. package/dist/author/design/categories/index.js +146 -0
  19. package/dist/author/design/choices/choice.d.ts +11 -0
  20. package/dist/author/design/choices/choice.js +129 -0
  21. package/dist/author/design/choices/config.d.ts +21 -0
  22. package/dist/author/design/choices/config.js +33 -0
  23. package/dist/author/design/choices/index.d.ts +41 -0
  24. package/dist/author/design/choices/index.js +110 -0
  25. package/dist/author/design/header.d.ts +24 -0
  26. package/dist/author/design/header.js +49 -0
  27. package/dist/author/design/index.d.ts +52 -0
  28. package/dist/author/design/index.js +417 -0
  29. package/dist/author/design/input-header.d.ts +39 -0
  30. package/dist/author/design/input-header.js +69 -0
  31. package/dist/author/design/utils.d.ts +9 -0
  32. package/dist/author/design/utils.js +7 -0
  33. package/dist/author/index.d.ts +51 -0
  34. package/dist/author/index.js +87 -0
  35. package/dist/author/main.d.ts +23 -0
  36. package/dist/author/main.js +30 -0
  37. package/dist/author/utils.d.ts +16 -0
  38. package/dist/author/utils.js +17 -0
  39. package/dist/controller/defaults.d.ts +34 -0
  40. package/dist/controller/defaults.js +29 -0
  41. package/dist/controller/index.d.ts +61 -0
  42. package/dist/controller/index.js +155 -0
  43. package/dist/controller/utils.d.ts +20 -0
  44. package/dist/controller/utils.js +35 -0
  45. package/dist/delivery/categorize/categories.d.ts +34 -0
  46. package/dist/delivery/categorize/categories.js +66 -0
  47. package/dist/delivery/categorize/category.d.ts +28 -0
  48. package/dist/delivery/categorize/category.js +48 -0
  49. package/dist/delivery/categorize/choice.d.ts +27 -0
  50. package/dist/delivery/categorize/choice.js +94 -0
  51. package/dist/delivery/categorize/choices.d.ts +39 -0
  52. package/dist/delivery/categorize/choices.js +51 -0
  53. package/dist/delivery/categorize/droppable-placeholder.d.ts +32 -0
  54. package/dist/delivery/categorize/droppable-placeholder.js +64 -0
  55. package/dist/delivery/categorize/grid-content.d.ts +25 -0
  56. package/dist/delivery/categorize/grid-content.js +39 -0
  57. package/dist/delivery/categorize/index.d.ts +57 -0
  58. package/dist/delivery/categorize/index.js +260 -0
  59. package/dist/delivery/index.d.ts +27 -0
  60. package/dist/delivery/index.js +152 -0
  61. package/dist/index.d.ts +1 -0
  62. package/dist/index.iife.d.ts +8 -0
  63. package/dist/index.iife.js +152 -0
  64. package/dist/index.js +2 -0
  65. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_DataView.js +6 -0
  66. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_Hash.js +16 -0
  67. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_ListCache.js +16 -0
  68. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_Map.js +6 -0
  69. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_MapCache.js +16 -0
  70. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_Promise.js +6 -0
  71. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_Set.js +6 -0
  72. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_Stack.js +14 -0
  73. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_Symbol.js +5 -0
  74. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_Uint8Array.js +5 -0
  75. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_WeakMap.js +6 -0
  76. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_arrayEach.js +7 -0
  77. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_arrayFilter.js +10 -0
  78. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_arrayLikeKeys.js +15 -0
  79. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_arrayPush.js +7 -0
  80. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_assignValue.js +10 -0
  81. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_assocIndexOf.js +8 -0
  82. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseAssign.js +8 -0
  83. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseAssignIn.js +8 -0
  84. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseAssignValue.js +12 -0
  85. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseClone.js +57 -0
  86. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseCreate.js +14 -0
  87. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseGetAllKeys.js +9 -0
  88. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseGetTag.js +10 -0
  89. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseIsArguments.js +9 -0
  90. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseIsMap.js +9 -0
  91. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseIsNative.js +11 -0
  92. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseIsSet.js +9 -0
  93. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseIsTypedArray.js +11 -0
  94. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseKeys.js +12 -0
  95. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseKeysIn.js +13 -0
  96. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseTimes.js +7 -0
  97. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_baseUnary.js +8 -0
  98. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_cloneArrayBuffer.js +8 -0
  99. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_cloneBuffer.js +10 -0
  100. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_cloneDataView.js +8 -0
  101. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_cloneRegExp.js +8 -0
  102. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_cloneSymbol.js +8 -0
  103. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_cloneTypedArray.js +8 -0
  104. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_copyArray.js +8 -0
  105. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_copyObject.js +14 -0
  106. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_copySymbols.js +8 -0
  107. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_copySymbolsIn.js +8 -0
  108. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_coreJsData.js +5 -0
  109. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_defineProperty.js +10 -0
  110. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_freeGlobal.js +4 -0
  111. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getAllKeys.js +9 -0
  112. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getAllKeysIn.js +9 -0
  113. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getMapData.js +8 -0
  114. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getNative.js +9 -0
  115. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getPrototype.js +5 -0
  116. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getRawTag.js +14 -0
  117. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getSymbols.js +10 -0
  118. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getSymbolsIn.js +11 -0
  119. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getTag.js +23 -0
  120. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_getValue.js +6 -0
  121. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_hashClear.js +7 -0
  122. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_hashDelete.js +7 -0
  123. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_hashGet.js +13 -0
  124. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_hashHas.js +9 -0
  125. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_hashSet.js +9 -0
  126. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_initCloneArray.js +8 -0
  127. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_initCloneByTag.js +33 -0
  128. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_initCloneObject.js +9 -0
  129. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_isIndex.js +8 -0
  130. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_isKeyable.js +7 -0
  131. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_isMasked.js +11 -0
  132. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_isPrototype.js +8 -0
  133. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_listCacheClear.js +6 -0
  134. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_listCacheDelete.js +9 -0
  135. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_listCacheGet.js +8 -0
  136. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_listCacheHas.js +7 -0
  137. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_listCacheSet.js +8 -0
  138. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_mapCacheClear.js +13 -0
  139. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_mapCacheDelete.js +8 -0
  140. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_mapCacheGet.js +7 -0
  141. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_mapCacheHas.js +7 -0
  142. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_mapCacheSet.js +8 -0
  143. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_nativeCreate.js +5 -0
  144. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_nativeKeys.js +5 -0
  145. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_nativeKeysIn.js +8 -0
  146. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_nodeUtil.js +9 -0
  147. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_objectToString.js +7 -0
  148. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_overArg.js +8 -0
  149. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_root.js +5 -0
  150. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_stackClear.js +7 -0
  151. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_stackDelete.js +7 -0
  152. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_stackGet.js +6 -0
  153. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_stackHas.js +6 -0
  154. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_stackSet.js +16 -0
  155. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/_toSource.js +15 -0
  156. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/cloneDeep.js +8 -0
  157. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/eq.js +6 -0
  158. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isArguments.js +10 -0
  159. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isArray.js +4 -0
  160. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isArrayLike.js +8 -0
  161. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isBuffer.js +6 -0
  162. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isEmpty.js +21 -0
  163. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isFunction.js +11 -0
  164. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isLength.js +7 -0
  165. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isMap.js +7 -0
  166. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isObject.js +7 -0
  167. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isObjectLike.js +6 -0
  168. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isSet.js +7 -0
  169. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/isTypedArray.js +7 -0
  170. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/keys.js +9 -0
  171. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/keysIn.js +9 -0
  172. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/stubArray.js +6 -0
  173. package/dist/node_modules/.bun/lodash-es@4.18.1/node_modules/lodash-es/stubFalse.js +6 -0
  174. package/package.json +52 -16
  175. package/CHANGELOG.json +0 -1637
  176. package/CHANGELOG.md +0 -2524
  177. package/LICENSE.md +0 -5
  178. package/README.md +0 -5
  179. package/configure/CHANGELOG.json +0 -1202
  180. package/configure/CHANGELOG.md +0 -2107
  181. package/configure/lib/defaults.js +0 -222
  182. package/configure/lib/defaults.js.map +0 -1
  183. package/configure/lib/design/builder.js +0 -55
  184. package/configure/lib/design/builder.js.map +0 -1
  185. package/configure/lib/design/buttons.js +0 -59
  186. package/configure/lib/design/buttons.js.map +0 -1
  187. package/configure/lib/design/categories/RowLabel.js +0 -66
  188. package/configure/lib/design/categories/RowLabel.js.map +0 -1
  189. package/configure/lib/design/categories/alternateResponses.js +0 -116
  190. package/configure/lib/design/categories/alternateResponses.js.map +0 -1
  191. package/configure/lib/design/categories/category.js +0 -153
  192. package/configure/lib/design/categories/category.js.map +0 -1
  193. package/configure/lib/design/categories/choice-preview.js +0 -79
  194. package/configure/lib/design/categories/choice-preview.js.map +0 -1
  195. package/configure/lib/design/categories/droppable-placeholder.js +0 -93
  196. package/configure/lib/design/categories/droppable-placeholder.js.map +0 -1
  197. package/configure/lib/design/categories/index.js +0 -256
  198. package/configure/lib/design/categories/index.js.map +0 -1
  199. package/configure/lib/design/choices/choice.js +0 -187
  200. package/configure/lib/design/choices/choice.js.map +0 -1
  201. package/configure/lib/design/choices/config.js +0 -58
  202. package/configure/lib/design/choices/config.js.map +0 -1
  203. package/configure/lib/design/choices/index.js +0 -197
  204. package/configure/lib/design/choices/index.js.map +0 -1
  205. package/configure/lib/design/header.js +0 -71
  206. package/configure/lib/design/header.js.map +0 -1
  207. package/configure/lib/design/index.js +0 -727
  208. package/configure/lib/design/index.js.map +0 -1
  209. package/configure/lib/design/input-header.js +0 -105
  210. package/configure/lib/design/input-header.js.map +0 -1
  211. package/configure/lib/design/utils.js +0 -12
  212. package/configure/lib/design/utils.js.map +0 -1
  213. package/configure/lib/index.js +0 -147
  214. package/configure/lib/index.js.map +0 -1
  215. package/configure/lib/main.js +0 -44
  216. package/configure/lib/main.js.map +0 -1
  217. package/configure/lib/utils.js +0 -43
  218. package/configure/lib/utils.js.map +0 -1
  219. package/configure/package.json +0 -32
  220. package/controller/CHANGELOG.json +0 -452
  221. package/controller/CHANGELOG.md +0 -1366
  222. package/controller/lib/defaults.js +0 -33
  223. package/controller/lib/defaults.js.map +0 -1
  224. package/controller/lib/index.js +0 -479
  225. package/controller/lib/index.js.map +0 -1
  226. package/controller/lib/utils.js +0 -69
  227. package/controller/lib/utils.js.map +0 -1
  228. package/controller/package.json +0 -18
  229. package/docs/config-schema.json +0 -2897
  230. package/docs/config-schema.json.md +0 -2138
  231. package/docs/demo/config.js +0 -8
  232. package/docs/demo/generate.js +0 -357
  233. package/docs/demo/index.html +0 -1
  234. package/docs/demo/session.js +0 -12
  235. package/docs/pie-schema.json +0 -1784
  236. package/docs/pie-schema.json.md +0 -1046
  237. package/lib/categorize/categories.js +0 -135
  238. package/lib/categorize/categories.js.map +0 -1
  239. package/lib/categorize/category.js +0 -67
  240. package/lib/categorize/category.js.map +0 -1
  241. package/lib/categorize/choice.js +0 -140
  242. package/lib/categorize/choice.js.map +0 -1
  243. package/lib/categorize/choices.js +0 -99
  244. package/lib/categorize/choices.js.map +0 -1
  245. package/lib/categorize/droppable-placeholder.js +0 -84
  246. package/lib/categorize/droppable-placeholder.js.map +0 -1
  247. package/lib/categorize/grid-content.js +0 -55
  248. package/lib/categorize/grid-content.js.map +0 -1
  249. package/lib/categorize/index.js +0 -450
  250. package/lib/categorize/index.js.map +0 -1
  251. package/lib/index.js +0 -316
  252. package/lib/index.js.map +0 -1
@@ -1,2138 +0,0 @@
1
- Config Object for @pie-elements/categorize
2
-
3
- The schema defines the following properties:
4
-
5
- # `baseInputConfiguration` (object)
6
-
7
- Properties of the `baseInputConfiguration` object:
8
-
9
- ## `math` (object)
10
-
11
- Properties of the `math` object:
12
-
13
- ### `disabled` (boolean)
14
-
15
- Indicates if the plugin is disabled or not
16
-
17
- ## `audio` (object)
18
-
19
- Properties of the `audio` object:
20
-
21
- ### `disabled` (boolean)
22
-
23
- Indicates if the plugin is disabled or not
24
-
25
- ## `video` (object)
26
-
27
- Properties of the `video` object:
28
-
29
- ### `disabled` (boolean)
30
-
31
- Indicates if the plugin is disabled or not
32
-
33
- ## `image` (object)
34
-
35
- Properties of the `image` object:
36
-
37
- ### `disabled` (boolean)
38
-
39
- Indicates if the plugin is disabled or not
40
-
41
- ## `customPlugins` (array)
42
-
43
- An array of objects that determine custom plugins.
44
- 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).
45
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
46
-
47
- The object is an array with all elements of the type `object`.
48
-
49
- The array object has the following properties:
50
-
51
- ### `event` (string, required)
52
-
53
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
54
- PIE will emit the event prefixed with "PIE-".
55
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
56
-
57
- ### `iconAlt` (string, required)
58
-
59
- The alt for the custom button icon
60
-
61
- ### `iconType` (string, required)
62
-
63
- The icon type.
64
- Currently, only "SVG" is supported.
65
-
66
- ### `icon` (string, required)
67
-
68
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
69
-
70
- ## `blockquote` (object)
71
-
72
- Properties of the `blockquote` object:
73
-
74
- ### `disabled` (boolean)
75
-
76
- Indicates if the plugin is disabled or not
77
-
78
- ## `h3` (object)
79
-
80
- Properties of the `h3` object:
81
-
82
- ### `disabled` (boolean)
83
-
84
- Indicates if the plugin is disabled or not
85
-
86
- ## `characters` (object)
87
-
88
- Properties of the `characters` object:
89
-
90
- ### `disabled` (boolean)
91
-
92
- Indicates if the plugin is disabled or not
93
-
94
- ## `bold` (object)
95
-
96
- Properties of the `bold` object:
97
-
98
- ### `disabled` (boolean)
99
-
100
- Indicates if the plugin is disabled or not
101
-
102
- ## `html` (object)
103
-
104
- Properties of the `html` object:
105
-
106
- ### `disabled` (boolean)
107
-
108
- Indicates if the plugin is disabled or not
109
-
110
- ## `italic` (object)
111
-
112
- Properties of the `italic` object:
113
-
114
- ### `disabled` (boolean)
115
-
116
- Indicates if the plugin is disabled or not
117
-
118
- ## `ol_list` (object)
119
-
120
- Properties of the `ol_list` object:
121
-
122
- ### `disabled` (boolean)
123
-
124
- Indicates if the plugin is disabled or not
125
-
126
- ## `redo` (object)
127
-
128
- Properties of the `redo` object:
129
-
130
- ### `disabled` (boolean)
131
-
132
- Indicates if the plugin is disabled or not
133
-
134
- ## `strikethrough` (object)
135
-
136
- Properties of the `strikethrough` object:
137
-
138
- ### `disabled` (boolean)
139
-
140
- Indicates if the plugin is disabled or not
141
-
142
- ## `sub` (object)
143
-
144
- Properties of the `sub` object:
145
-
146
- ### `disabled` (boolean)
147
-
148
- Indicates if the plugin is disabled or not
149
-
150
- ## `sup` (object)
151
-
152
- Properties of the `sup` object:
153
-
154
- ### `disabled` (boolean)
155
-
156
- Indicates if the plugin is disabled or not
157
-
158
- ## `table` (object)
159
-
160
- Properties of the `table` object:
161
-
162
- ### `disabled` (boolean)
163
-
164
- Indicates if the plugin is disabled or not
165
-
166
- ## `ul_list` (object)
167
-
168
- Properties of the `ul_list` object:
169
-
170
- ### `disabled` (boolean)
171
-
172
- Indicates if the plugin is disabled or not
173
-
174
- ## `underline` (object)
175
-
176
- Properties of the `underline` object:
177
-
178
- ### `disabled` (boolean)
179
-
180
- Indicates if the plugin is disabled or not
181
-
182
- ## `undo` (object)
183
-
184
- Properties of the `undo` object:
185
-
186
- ### `disabled` (boolean)
187
-
188
- Indicates if the plugin is disabled or not
189
-
190
- # `partialScoring` (object)
191
-
192
- Properties of the `partialScoring` object:
193
-
194
- ## `settings` (boolean)
195
-
196
- Indicates if the item has to be displayed in the Settings Panel
197
-
198
- ## `label` (string)
199
-
200
- Indicates the label for the item that has to be displayed in the Settings Panel
201
-
202
- # `rationale` (object)
203
-
204
- Properties of the `rationale` object:
205
-
206
- ## `inputConfiguration` (object)
207
-
208
- Properties of the `inputConfiguration` object:
209
-
210
- ### `math` (object)
211
-
212
- Properties of the `math` object:
213
-
214
- #### `disabled` (boolean)
215
-
216
- Indicates if the plugin is disabled or not
217
-
218
- ### `audio` (object)
219
-
220
- Properties of the `audio` object:
221
-
222
- #### `disabled` (boolean)
223
-
224
- Indicates if the plugin is disabled or not
225
-
226
- ### `video` (object)
227
-
228
- Properties of the `video` object:
229
-
230
- #### `disabled` (boolean)
231
-
232
- Indicates if the plugin is disabled or not
233
-
234
- ### `image` (object)
235
-
236
- Properties of the `image` object:
237
-
238
- #### `disabled` (boolean)
239
-
240
- Indicates if the plugin is disabled or not
241
-
242
- ### `customPlugins` (array)
243
-
244
- An array of objects that determine custom plugins.
245
- 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).
246
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
247
-
248
- The object is an array with all elements of the type `object`.
249
-
250
- The array object has the following properties:
251
-
252
- #### `event` (string, required)
253
-
254
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
255
- PIE will emit the event prefixed with "PIE-".
256
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
257
-
258
- #### `iconAlt` (string, required)
259
-
260
- The alt for the custom button icon
261
-
262
- #### `iconType` (string, required)
263
-
264
- The icon type.
265
- Currently, only "SVG" is supported.
266
-
267
- #### `icon` (string, required)
268
-
269
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
270
-
271
- ### `blockquote` (object)
272
-
273
- Properties of the `blockquote` object:
274
-
275
- #### `disabled` (boolean)
276
-
277
- Indicates if the plugin is disabled or not
278
-
279
- ### `h3` (object)
280
-
281
- Properties of the `h3` object:
282
-
283
- #### `disabled` (boolean)
284
-
285
- Indicates if the plugin is disabled or not
286
-
287
- ### `characters` (object)
288
-
289
- Properties of the `characters` object:
290
-
291
- #### `disabled` (boolean)
292
-
293
- Indicates if the plugin is disabled or not
294
-
295
- ### `bold` (object)
296
-
297
- Properties of the `bold` object:
298
-
299
- #### `disabled` (boolean)
300
-
301
- Indicates if the plugin is disabled or not
302
-
303
- ### `html` (object)
304
-
305
- Properties of the `html` object:
306
-
307
- #### `disabled` (boolean)
308
-
309
- Indicates if the plugin is disabled or not
310
-
311
- ### `italic` (object)
312
-
313
- Properties of the `italic` object:
314
-
315
- #### `disabled` (boolean)
316
-
317
- Indicates if the plugin is disabled or not
318
-
319
- ### `ol_list` (object)
320
-
321
- Properties of the `ol_list` object:
322
-
323
- #### `disabled` (boolean)
324
-
325
- Indicates if the plugin is disabled or not
326
-
327
- ### `redo` (object)
328
-
329
- Properties of the `redo` object:
330
-
331
- #### `disabled` (boolean)
332
-
333
- Indicates if the plugin is disabled or not
334
-
335
- ### `strikethrough` (object)
336
-
337
- Properties of the `strikethrough` object:
338
-
339
- #### `disabled` (boolean)
340
-
341
- Indicates if the plugin is disabled or not
342
-
343
- ### `sub` (object)
344
-
345
- Properties of the `sub` object:
346
-
347
- #### `disabled` (boolean)
348
-
349
- Indicates if the plugin is disabled or not
350
-
351
- ### `sup` (object)
352
-
353
- Properties of the `sup` object:
354
-
355
- #### `disabled` (boolean)
356
-
357
- Indicates if the plugin is disabled or not
358
-
359
- ### `table` (object)
360
-
361
- Properties of the `table` object:
362
-
363
- #### `disabled` (boolean)
364
-
365
- Indicates if the plugin is disabled or not
366
-
367
- ### `ul_list` (object)
368
-
369
- Properties of the `ul_list` object:
370
-
371
- #### `disabled` (boolean)
372
-
373
- Indicates if the plugin is disabled or not
374
-
375
- ### `underline` (object)
376
-
377
- Properties of the `underline` object:
378
-
379
- #### `disabled` (boolean)
380
-
381
- Indicates if the plugin is disabled or not
382
-
383
- ### `undo` (object)
384
-
385
- Properties of the `undo` object:
386
-
387
- #### `disabled` (boolean)
388
-
389
- Indicates if the plugin is disabled or not
390
-
391
- ## `required` (boolean)
392
-
393
- Indicates if the item is required and the value cannot be empty
394
-
395
- ## `settings` (boolean)
396
-
397
- Indicates if the item has to be displayed in the Settings Panel
398
-
399
- ## `label` (string)
400
-
401
- Indicates the label for the item that has to be displayed in the Settings Panel
402
-
403
- # `spellCheck` (object)
404
-
405
- Properties of the `spellCheck` object:
406
-
407
- ## `settings` (boolean)
408
-
409
- Indicates if the item has to be displayed in the Settings Panel
410
-
411
- ## `label` (string)
412
-
413
- Indicates the label for the item that has to be displayed in the Settings Panel
414
-
415
- # `scoringType` (object)
416
-
417
- Properties of the `scoringType` object:
418
-
419
- ## `settings` (boolean)
420
-
421
- Indicates if the item has to be displayed in the Settings Panel
422
-
423
- ## `label` (string)
424
-
425
- Indicates the label for the item that has to be displayed in the Settings Panel
426
-
427
- # `settingsPanelDisabled` (boolean)
428
-
429
- Indicates if the settings panel is not available
430
-
431
- # `studentInstructions` (object)
432
-
433
- Properties of the `studentInstructions` object:
434
-
435
- ## `settings` (boolean)
436
-
437
- Indicates if the item has to be displayed in the Settings Panel
438
-
439
- ## `label` (string)
440
-
441
- Indicates the label for the item that has to be displayed in the Settings Panel
442
-
443
- # `teacherInstructions` (object)
444
-
445
- Properties of the `teacherInstructions` object:
446
-
447
- ## `inputConfiguration` (object)
448
-
449
- Properties of the `inputConfiguration` object:
450
-
451
- ### `math` (object)
452
-
453
- Properties of the `math` object:
454
-
455
- #### `disabled` (boolean)
456
-
457
- Indicates if the plugin is disabled or not
458
-
459
- ### `audio` (object)
460
-
461
- Properties of the `audio` object:
462
-
463
- #### `disabled` (boolean)
464
-
465
- Indicates if the plugin is disabled or not
466
-
467
- ### `video` (object)
468
-
469
- Properties of the `video` object:
470
-
471
- #### `disabled` (boolean)
472
-
473
- Indicates if the plugin is disabled or not
474
-
475
- ### `image` (object)
476
-
477
- Properties of the `image` object:
478
-
479
- #### `disabled` (boolean)
480
-
481
- Indicates if the plugin is disabled or not
482
-
483
- ### `customPlugins` (array)
484
-
485
- An array of objects that determine custom plugins.
486
- 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).
487
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
488
-
489
- The object is an array with all elements of the type `object`.
490
-
491
- The array object has the following properties:
492
-
493
- #### `event` (string, required)
494
-
495
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
496
- PIE will emit the event prefixed with "PIE-".
497
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
498
-
499
- #### `iconAlt` (string, required)
500
-
501
- The alt for the custom button icon
502
-
503
- #### `iconType` (string, required)
504
-
505
- The icon type.
506
- Currently, only "SVG" is supported.
507
-
508
- #### `icon` (string, required)
509
-
510
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
511
-
512
- ### `blockquote` (object)
513
-
514
- Properties of the `blockquote` object:
515
-
516
- #### `disabled` (boolean)
517
-
518
- Indicates if the plugin is disabled or not
519
-
520
- ### `h3` (object)
521
-
522
- Properties of the `h3` object:
523
-
524
- #### `disabled` (boolean)
525
-
526
- Indicates if the plugin is disabled or not
527
-
528
- ### `characters` (object)
529
-
530
- Properties of the `characters` object:
531
-
532
- #### `disabled` (boolean)
533
-
534
- Indicates if the plugin is disabled or not
535
-
536
- ### `bold` (object)
537
-
538
- Properties of the `bold` object:
539
-
540
- #### `disabled` (boolean)
541
-
542
- Indicates if the plugin is disabled or not
543
-
544
- ### `html` (object)
545
-
546
- Properties of the `html` object:
547
-
548
- #### `disabled` (boolean)
549
-
550
- Indicates if the plugin is disabled or not
551
-
552
- ### `italic` (object)
553
-
554
- Properties of the `italic` object:
555
-
556
- #### `disabled` (boolean)
557
-
558
- Indicates if the plugin is disabled or not
559
-
560
- ### `ol_list` (object)
561
-
562
- Properties of the `ol_list` object:
563
-
564
- #### `disabled` (boolean)
565
-
566
- Indicates if the plugin is disabled or not
567
-
568
- ### `redo` (object)
569
-
570
- Properties of the `redo` object:
571
-
572
- #### `disabled` (boolean)
573
-
574
- Indicates if the plugin is disabled or not
575
-
576
- ### `strikethrough` (object)
577
-
578
- Properties of the `strikethrough` object:
579
-
580
- #### `disabled` (boolean)
581
-
582
- Indicates if the plugin is disabled or not
583
-
584
- ### `sub` (object)
585
-
586
- Properties of the `sub` object:
587
-
588
- #### `disabled` (boolean)
589
-
590
- Indicates if the plugin is disabled or not
591
-
592
- ### `sup` (object)
593
-
594
- Properties of the `sup` object:
595
-
596
- #### `disabled` (boolean)
597
-
598
- Indicates if the plugin is disabled or not
599
-
600
- ### `table` (object)
601
-
602
- Properties of the `table` object:
603
-
604
- #### `disabled` (boolean)
605
-
606
- Indicates if the plugin is disabled or not
607
-
608
- ### `ul_list` (object)
609
-
610
- Properties of the `ul_list` object:
611
-
612
- #### `disabled` (boolean)
613
-
614
- Indicates if the plugin is disabled or not
615
-
616
- ### `underline` (object)
617
-
618
- Properties of the `underline` object:
619
-
620
- #### `disabled` (boolean)
621
-
622
- Indicates if the plugin is disabled or not
623
-
624
- ### `undo` (object)
625
-
626
- Properties of the `undo` object:
627
-
628
- #### `disabled` (boolean)
629
-
630
- Indicates if the plugin is disabled or not
631
-
632
- ## `required` (boolean)
633
-
634
- Indicates if the item is required and the value cannot be empty
635
-
636
- ## `settings` (boolean)
637
-
638
- Indicates if the item has to be displayed in the Settings Panel
639
-
640
- ## `label` (string)
641
-
642
- Indicates the label for the item that has to be displayed in the Settings Panel
643
-
644
- # `prompt` (object)
645
-
646
- Properties of the `prompt` object:
647
-
648
- ## `inputConfiguration` (object)
649
-
650
- Properties of the `inputConfiguration` object:
651
-
652
- ### `math` (object)
653
-
654
- Properties of the `math` object:
655
-
656
- #### `disabled` (boolean)
657
-
658
- Indicates if the plugin is disabled or not
659
-
660
- ### `audio` (object)
661
-
662
- Properties of the `audio` object:
663
-
664
- #### `disabled` (boolean)
665
-
666
- Indicates if the plugin is disabled or not
667
-
668
- ### `video` (object)
669
-
670
- Properties of the `video` object:
671
-
672
- #### `disabled` (boolean)
673
-
674
- Indicates if the plugin is disabled or not
675
-
676
- ### `image` (object)
677
-
678
- Properties of the `image` object:
679
-
680
- #### `disabled` (boolean)
681
-
682
- Indicates if the plugin is disabled or not
683
-
684
- ### `customPlugins` (array)
685
-
686
- An array of objects that determine custom plugins.
687
- 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).
688
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
689
-
690
- The object is an array with all elements of the type `object`.
691
-
692
- The array object has the following properties:
693
-
694
- #### `event` (string, required)
695
-
696
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
697
- PIE will emit the event prefixed with "PIE-".
698
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
699
-
700
- #### `iconAlt` (string, required)
701
-
702
- The alt for the custom button icon
703
-
704
- #### `iconType` (string, required)
705
-
706
- The icon type.
707
- Currently, only "SVG" is supported.
708
-
709
- #### `icon` (string, required)
710
-
711
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
712
-
713
- ### `blockquote` (object)
714
-
715
- Properties of the `blockquote` object:
716
-
717
- #### `disabled` (boolean)
718
-
719
- Indicates if the plugin is disabled or not
720
-
721
- ### `h3` (object)
722
-
723
- Properties of the `h3` object:
724
-
725
- #### `disabled` (boolean)
726
-
727
- Indicates if the plugin is disabled or not
728
-
729
- ### `characters` (object)
730
-
731
- Properties of the `characters` object:
732
-
733
- #### `disabled` (boolean)
734
-
735
- Indicates if the plugin is disabled or not
736
-
737
- ### `bold` (object)
738
-
739
- Properties of the `bold` object:
740
-
741
- #### `disabled` (boolean)
742
-
743
- Indicates if the plugin is disabled or not
744
-
745
- ### `html` (object)
746
-
747
- Properties of the `html` object:
748
-
749
- #### `disabled` (boolean)
750
-
751
- Indicates if the plugin is disabled or not
752
-
753
- ### `italic` (object)
754
-
755
- Properties of the `italic` object:
756
-
757
- #### `disabled` (boolean)
758
-
759
- Indicates if the plugin is disabled or not
760
-
761
- ### `ol_list` (object)
762
-
763
- Properties of the `ol_list` object:
764
-
765
- #### `disabled` (boolean)
766
-
767
- Indicates if the plugin is disabled or not
768
-
769
- ### `redo` (object)
770
-
771
- Properties of the `redo` object:
772
-
773
- #### `disabled` (boolean)
774
-
775
- Indicates if the plugin is disabled or not
776
-
777
- ### `strikethrough` (object)
778
-
779
- Properties of the `strikethrough` object:
780
-
781
- #### `disabled` (boolean)
782
-
783
- Indicates if the plugin is disabled or not
784
-
785
- ### `sub` (object)
786
-
787
- Properties of the `sub` object:
788
-
789
- #### `disabled` (boolean)
790
-
791
- Indicates if the plugin is disabled or not
792
-
793
- ### `sup` (object)
794
-
795
- Properties of the `sup` object:
796
-
797
- #### `disabled` (boolean)
798
-
799
- Indicates if the plugin is disabled or not
800
-
801
- ### `table` (object)
802
-
803
- Properties of the `table` object:
804
-
805
- #### `disabled` (boolean)
806
-
807
- Indicates if the plugin is disabled or not
808
-
809
- ### `ul_list` (object)
810
-
811
- Properties of the `ul_list` object:
812
-
813
- #### `disabled` (boolean)
814
-
815
- Indicates if the plugin is disabled or not
816
-
817
- ### `underline` (object)
818
-
819
- Properties of the `underline` object:
820
-
821
- #### `disabled` (boolean)
822
-
823
- Indicates if the plugin is disabled or not
824
-
825
- ### `undo` (object)
826
-
827
- Properties of the `undo` object:
828
-
829
- #### `disabled` (boolean)
830
-
831
- Indicates if the plugin is disabled or not
832
-
833
- ## `required` (boolean)
834
-
835
- Indicates if the item is required and the value cannot be empty
836
-
837
- ## `settings` (boolean)
838
-
839
- Indicates if the item has to be displayed in the Settings Panel
840
-
841
- ## `label` (string)
842
-
843
- Indicates the label for the item that has to be displayed in the Settings Panel
844
-
845
- # `headers` (object)
846
-
847
- Properties of the `headers` object:
848
-
849
- ## `inputConfiguration` (object)
850
-
851
- Properties of the `inputConfiguration` object:
852
-
853
- ### `math` (object)
854
-
855
- Properties of the `math` object:
856
-
857
- #### `disabled` (boolean)
858
-
859
- Indicates if the plugin is disabled or not
860
-
861
- ### `audio` (object)
862
-
863
- Properties of the `audio` object:
864
-
865
- #### `disabled` (boolean)
866
-
867
- Indicates if the plugin is disabled or not
868
-
869
- ### `video` (object)
870
-
871
- Properties of the `video` object:
872
-
873
- #### `disabled` (boolean)
874
-
875
- Indicates if the plugin is disabled or not
876
-
877
- ### `image` (object)
878
-
879
- Properties of the `image` object:
880
-
881
- #### `disabled` (boolean)
882
-
883
- Indicates if the plugin is disabled or not
884
-
885
- ### `customPlugins` (array)
886
-
887
- An array of objects that determine custom plugins.
888
- 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).
889
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
890
-
891
- The object is an array with all elements of the type `object`.
892
-
893
- The array object has the following properties:
894
-
895
- #### `event` (string, required)
896
-
897
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
898
- PIE will emit the event prefixed with "PIE-".
899
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
900
-
901
- #### `iconAlt` (string, required)
902
-
903
- The alt for the custom button icon
904
-
905
- #### `iconType` (string, required)
906
-
907
- The icon type.
908
- Currently, only "SVG" is supported.
909
-
910
- #### `icon` (string, required)
911
-
912
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
913
-
914
- ### `blockquote` (object)
915
-
916
- Properties of the `blockquote` object:
917
-
918
- #### `disabled` (boolean)
919
-
920
- Indicates if the plugin is disabled or not
921
-
922
- ### `h3` (object)
923
-
924
- Properties of the `h3` object:
925
-
926
- #### `disabled` (boolean)
927
-
928
- Indicates if the plugin is disabled or not
929
-
930
- ### `characters` (object)
931
-
932
- Properties of the `characters` object:
933
-
934
- #### `disabled` (boolean)
935
-
936
- Indicates if the plugin is disabled or not
937
-
938
- ### `bold` (object)
939
-
940
- Properties of the `bold` object:
941
-
942
- #### `disabled` (boolean)
943
-
944
- Indicates if the plugin is disabled or not
945
-
946
- ### `html` (object)
947
-
948
- Properties of the `html` object:
949
-
950
- #### `disabled` (boolean)
951
-
952
- Indicates if the plugin is disabled or not
953
-
954
- ### `italic` (object)
955
-
956
- Properties of the `italic` object:
957
-
958
- #### `disabled` (boolean)
959
-
960
- Indicates if the plugin is disabled or not
961
-
962
- ### `ol_list` (object)
963
-
964
- Properties of the `ol_list` object:
965
-
966
- #### `disabled` (boolean)
967
-
968
- Indicates if the plugin is disabled or not
969
-
970
- ### `redo` (object)
971
-
972
- Properties of the `redo` object:
973
-
974
- #### `disabled` (boolean)
975
-
976
- Indicates if the plugin is disabled or not
977
-
978
- ### `strikethrough` (object)
979
-
980
- Properties of the `strikethrough` object:
981
-
982
- #### `disabled` (boolean)
983
-
984
- Indicates if the plugin is disabled or not
985
-
986
- ### `sub` (object)
987
-
988
- Properties of the `sub` object:
989
-
990
- #### `disabled` (boolean)
991
-
992
- Indicates if the plugin is disabled or not
993
-
994
- ### `sup` (object)
995
-
996
- Properties of the `sup` object:
997
-
998
- #### `disabled` (boolean)
999
-
1000
- Indicates if the plugin is disabled or not
1001
-
1002
- ### `table` (object)
1003
-
1004
- Properties of the `table` object:
1005
-
1006
- #### `disabled` (boolean)
1007
-
1008
- Indicates if the plugin is disabled or not
1009
-
1010
- ### `ul_list` (object)
1011
-
1012
- Properties of the `ul_list` object:
1013
-
1014
- #### `disabled` (boolean)
1015
-
1016
- Indicates if the plugin is disabled or not
1017
-
1018
- ### `underline` (object)
1019
-
1020
- Properties of the `underline` object:
1021
-
1022
- #### `disabled` (boolean)
1023
-
1024
- Indicates if the plugin is disabled or not
1025
-
1026
- ### `undo` (object)
1027
-
1028
- Properties of the `undo` object:
1029
-
1030
- #### `disabled` (boolean)
1031
-
1032
- Indicates if the plugin is disabled or not
1033
-
1034
- ## `settings` (boolean)
1035
-
1036
- Indicates if the item has to be displayed in the Settings Panel
1037
-
1038
- ## `label` (string)
1039
-
1040
- Indicates the label for the item that has to be displayed in the Settings Panel
1041
-
1042
- # `rowLabels` (object)
1043
-
1044
- Properties of the `rowLabels` object:
1045
-
1046
- ## `inputConfiguration` (object)
1047
-
1048
- Properties of the `inputConfiguration` object:
1049
-
1050
- ### `math` (object)
1051
-
1052
- Properties of the `math` object:
1053
-
1054
- #### `disabled` (boolean)
1055
-
1056
- Indicates if the plugin is disabled or not
1057
-
1058
- ### `audio` (object)
1059
-
1060
- Properties of the `audio` object:
1061
-
1062
- #### `disabled` (boolean)
1063
-
1064
- Indicates if the plugin is disabled or not
1065
-
1066
- ### `video` (object)
1067
-
1068
- Properties of the `video` object:
1069
-
1070
- #### `disabled` (boolean)
1071
-
1072
- Indicates if the plugin is disabled or not
1073
-
1074
- ### `image` (object)
1075
-
1076
- Properties of the `image` object:
1077
-
1078
- #### `disabled` (boolean)
1079
-
1080
- Indicates if the plugin is disabled or not
1081
-
1082
- ### `customPlugins` (array)
1083
-
1084
- An array of objects that determine custom plugins.
1085
- 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).
1086
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1087
-
1088
- The object is an array with all elements of the type `object`.
1089
-
1090
- The array object has the following properties:
1091
-
1092
- #### `event` (string, required)
1093
-
1094
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1095
- PIE will emit the event prefixed with "PIE-".
1096
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1097
-
1098
- #### `iconAlt` (string, required)
1099
-
1100
- The alt for the custom button icon
1101
-
1102
- #### `iconType` (string, required)
1103
-
1104
- The icon type.
1105
- Currently, only "SVG" is supported.
1106
-
1107
- #### `icon` (string, required)
1108
-
1109
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1110
-
1111
- ### `blockquote` (object)
1112
-
1113
- Properties of the `blockquote` object:
1114
-
1115
- #### `disabled` (boolean)
1116
-
1117
- Indicates if the plugin is disabled or not
1118
-
1119
- ### `h3` (object)
1120
-
1121
- Properties of the `h3` object:
1122
-
1123
- #### `disabled` (boolean)
1124
-
1125
- Indicates if the plugin is disabled or not
1126
-
1127
- ### `characters` (object)
1128
-
1129
- Properties of the `characters` object:
1130
-
1131
- #### `disabled` (boolean)
1132
-
1133
- Indicates if the plugin is disabled or not
1134
-
1135
- ### `bold` (object)
1136
-
1137
- Properties of the `bold` object:
1138
-
1139
- #### `disabled` (boolean)
1140
-
1141
- Indicates if the plugin is disabled or not
1142
-
1143
- ### `html` (object)
1144
-
1145
- Properties of the `html` object:
1146
-
1147
- #### `disabled` (boolean)
1148
-
1149
- Indicates if the plugin is disabled or not
1150
-
1151
- ### `italic` (object)
1152
-
1153
- Properties of the `italic` object:
1154
-
1155
- #### `disabled` (boolean)
1156
-
1157
- Indicates if the plugin is disabled or not
1158
-
1159
- ### `ol_list` (object)
1160
-
1161
- Properties of the `ol_list` object:
1162
-
1163
- #### `disabled` (boolean)
1164
-
1165
- Indicates if the plugin is disabled or not
1166
-
1167
- ### `redo` (object)
1168
-
1169
- Properties of the `redo` object:
1170
-
1171
- #### `disabled` (boolean)
1172
-
1173
- Indicates if the plugin is disabled or not
1174
-
1175
- ### `strikethrough` (object)
1176
-
1177
- Properties of the `strikethrough` object:
1178
-
1179
- #### `disabled` (boolean)
1180
-
1181
- Indicates if the plugin is disabled or not
1182
-
1183
- ### `sub` (object)
1184
-
1185
- Properties of the `sub` object:
1186
-
1187
- #### `disabled` (boolean)
1188
-
1189
- Indicates if the plugin is disabled or not
1190
-
1191
- ### `sup` (object)
1192
-
1193
- Properties of the `sup` object:
1194
-
1195
- #### `disabled` (boolean)
1196
-
1197
- Indicates if the plugin is disabled or not
1198
-
1199
- ### `table` (object)
1200
-
1201
- Properties of the `table` object:
1202
-
1203
- #### `disabled` (boolean)
1204
-
1205
- Indicates if the plugin is disabled or not
1206
-
1207
- ### `ul_list` (object)
1208
-
1209
- Properties of the `ul_list` object:
1210
-
1211
- #### `disabled` (boolean)
1212
-
1213
- Indicates if the plugin is disabled or not
1214
-
1215
- ### `underline` (object)
1216
-
1217
- Properties of the `underline` object:
1218
-
1219
- #### `disabled` (boolean)
1220
-
1221
- Indicates if the plugin is disabled or not
1222
-
1223
- ### `undo` (object)
1224
-
1225
- Properties of the `undo` object:
1226
-
1227
- #### `disabled` (boolean)
1228
-
1229
- Indicates if the plugin is disabled or not
1230
-
1231
- ## `settings` (boolean)
1232
-
1233
- Indicates if the item has to be displayed in the Settings Panel
1234
-
1235
- ## `label` (string)
1236
-
1237
- Indicates the label for the item that has to be displayed in the Settings Panel
1238
-
1239
- # `minChoices` (number)
1240
-
1241
- Minimum number of choices
1242
-
1243
- # `maxChoices` (number)
1244
-
1245
- Maximum number of choices
1246
-
1247
- # `choicesPosition` (object)
1248
-
1249
- Properties of the `choicesPosition` object:
1250
-
1251
- ## `settings` (boolean)
1252
-
1253
- Indicates if the item has to be displayed in the Settings Panel
1254
-
1255
- ## `label` (string)
1256
-
1257
- Indicates the label for the item that has to be displayed in the Settings Panel
1258
-
1259
- # `mathMlOptions` (object)
1260
-
1261
- Properties of the `mathMlOptions` object:
1262
-
1263
- ## `mmlOutput` (number)
1264
-
1265
- Indicates if model should have mathML output instead of latex
1266
-
1267
- ## `mmlEditing` (number)
1268
-
1269
- Indicates if mathML that's already in model should be editable
1270
-
1271
- # `maxCategories` (number)
1272
-
1273
- Maximum number of categories
1274
-
1275
- # `minCategoriesPerRow` (number)
1276
-
1277
- Minimum value of categories per row
1278
-
1279
- # `maxImageWidth` (object)
1280
-
1281
- Properties of the `maxImageWidth` object:
1282
-
1283
- ## `teacherInstructions` (number)
1284
-
1285
- Indicates the max dimension for images in teacher instructions
1286
-
1287
- ## `prompt` (number)
1288
-
1289
- Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1290
-
1291
- ## `rationale` (number)
1292
-
1293
- Indicates the max dimension for images in rationale
1294
-
1295
- ## `choices` (number)
1296
-
1297
- Indicates the max dimension for images in choices
1298
-
1299
- ## `rowLabel` (number)
1300
-
1301
- Indicates the max dimension for images in row labels
1302
-
1303
- ## `categoryLabel` (number)
1304
-
1305
- Indicates the max dimension for images in category labels
1306
-
1307
- # `maxImageHeight` (object)
1308
-
1309
- Properties of the `maxImageHeight` object:
1310
-
1311
- ## `teacherInstructions` (number)
1312
-
1313
- Indicates the max dimension for images in teacher instructions
1314
-
1315
- ## `prompt` (number)
1316
-
1317
- Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1318
-
1319
- ## `rationale` (number)
1320
-
1321
- Indicates the max dimension for images in rationale
1322
-
1323
- ## `choices` (number)
1324
-
1325
- Indicates the max dimension for images in choices
1326
-
1327
- ## `rowLabel` (number)
1328
-
1329
- Indicates the max dimension for images in row labels
1330
-
1331
- ## `categoryLabel` (number)
1332
-
1333
- Indicates the max dimension for images in category labels
1334
-
1335
- # `withRubric` (object)
1336
-
1337
- Properties of the `withRubric` object:
1338
-
1339
- ## `settings` (boolean)
1340
-
1341
- Indicates if the item has to be displayed in the Settings Panel
1342
-
1343
- ## `label` (string)
1344
-
1345
- Indicates the label for the item that has to be displayed in the Settings Panel
1346
-
1347
- # `language` (object)
1348
-
1349
- Properties of the `language` object:
1350
-
1351
- ## `enabled` (boolean)
1352
-
1353
- Indicates the value of the item if it affects config-ui
1354
- (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
1355
-
1356
- ## `settings` (boolean)
1357
-
1358
- Indicates if the item has to be displayed in the Settings Panel
1359
-
1360
- ## `label` (string)
1361
-
1362
- Indicates the label for the item that has to be displayed in the Settings Panel
1363
-
1364
- # `languageChoices` (object)
1365
-
1366
- Language choices configuration
1367
- Only available if language is enabled
1368
-
1369
- Properties of the `languageChoices` object:
1370
-
1371
- ## `label` (string, required)
1372
-
1373
- ## `options` (array, required)
1374
-
1375
- The object is an array with all elements of the type `object`.
1376
-
1377
- The array object has the following properties:
1378
-
1379
- ### `value` (string, required)
1380
-
1381
- Value of the language option
1382
-
1383
- ### `label` (string, required)
1384
-
1385
- Label of the language option
1386
-
1387
- # `allowMaxAnswerChoices` (object)
1388
-
1389
- Properties of the `allowMaxAnswerChoices` object:
1390
-
1391
- ## `settings` (boolean)
1392
-
1393
- Indicates if the item has to be displayed in the Settings Panel
1394
-
1395
- ## `label` (string)
1396
-
1397
- Indicates the label for the item that has to be displayed in the Settings Panel
1398
-
1399
- # `contentDimensions` (object)
1400
-
1401
- Indicates the dimensions configuration for the authoring container
1402
- Note: Some items have a default minimum width because of their content, but if
1403
- the minWidth is lower than this, the overflow behavior will take care of that
1404
-
1405
- Properties of the `contentDimensions` object:
1406
-
1407
- ## `maxHeight` (string,number)
1408
-
1409
- Indicates the max height of the authoring container
1410
-
1411
- Default: `"undefined"`
1412
-
1413
- ## `maxWidth` (string,number)
1414
-
1415
- Indicates the max width of the authoring container
1416
-
1417
- Default: `"undefined"`
1418
-
1419
- ## `minHeight` (string,number)
1420
-
1421
- Indicates the min height of the authoring container
1422
-
1423
- Default: `"undefined"`
1424
-
1425
- ## `minWidth` (string,number)
1426
-
1427
- Indicates the min width of the authoring container
1428
-
1429
- Default: `"undefined"`
1430
-
1431
- Default: `": {}"`
1432
-
1433
- # `settingsPartialScoring` (boolean)
1434
-
1435
- Indicates whether the settings panel wil allow the author to modify settings for partial scoring
1436
-
1437
- Default: `true`
1438
-
1439
- ---
1440
-
1441
- # Sub Schemas
1442
-
1443
- The schema defines the following additional types:
1444
-
1445
- ## `EditableHtmlConfigureProp` (object)
1446
-
1447
- Properties of the `EditableHtmlConfigureProp` object:
1448
-
1449
- ### `math` (object)
1450
-
1451
- Properties of the `math` object:
1452
-
1453
- #### `disabled` (boolean)
1454
-
1455
- Indicates if the plugin is disabled or not
1456
-
1457
- ### `audio` (object)
1458
-
1459
- Properties of the `audio` object:
1460
-
1461
- #### `disabled` (boolean)
1462
-
1463
- Indicates if the plugin is disabled or not
1464
-
1465
- ### `video` (object)
1466
-
1467
- Properties of the `video` object:
1468
-
1469
- #### `disabled` (boolean)
1470
-
1471
- Indicates if the plugin is disabled or not
1472
-
1473
- ### `image` (object)
1474
-
1475
- Properties of the `image` object:
1476
-
1477
- #### `disabled` (boolean)
1478
-
1479
- Indicates if the plugin is disabled or not
1480
-
1481
- ### `customPlugins` (array)
1482
-
1483
- An array of objects that determine custom plugins.
1484
- 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).
1485
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1486
-
1487
- The object is an array with all elements of the type `object`.
1488
-
1489
- The array object has the following properties:
1490
-
1491
- #### `event` (string, required)
1492
-
1493
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1494
- PIE will emit the event prefixed with "PIE-".
1495
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1496
-
1497
- #### `iconAlt` (string, required)
1498
-
1499
- The alt for the custom button icon
1500
-
1501
- #### `iconType` (string, required)
1502
-
1503
- The icon type.
1504
- Currently, only "SVG" is supported.
1505
-
1506
- #### `icon` (string, required)
1507
-
1508
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1509
-
1510
- ### `blockquote` (object)
1511
-
1512
- Properties of the `blockquote` object:
1513
-
1514
- #### `disabled` (boolean)
1515
-
1516
- Indicates if the plugin is disabled or not
1517
-
1518
- ### `h3` (object)
1519
-
1520
- Properties of the `h3` object:
1521
-
1522
- #### `disabled` (boolean)
1523
-
1524
- Indicates if the plugin is disabled or not
1525
-
1526
- ### `characters` (object)
1527
-
1528
- Properties of the `characters` object:
1529
-
1530
- #### `disabled` (boolean)
1531
-
1532
- Indicates if the plugin is disabled or not
1533
-
1534
- ### `bold` (object)
1535
-
1536
- Properties of the `bold` object:
1537
-
1538
- #### `disabled` (boolean)
1539
-
1540
- Indicates if the plugin is disabled or not
1541
-
1542
- ### `html` (object)
1543
-
1544
- Properties of the `html` object:
1545
-
1546
- #### `disabled` (boolean)
1547
-
1548
- Indicates if the plugin is disabled or not
1549
-
1550
- ### `italic` (object)
1551
-
1552
- Properties of the `italic` object:
1553
-
1554
- #### `disabled` (boolean)
1555
-
1556
- Indicates if the plugin is disabled or not
1557
-
1558
- ### `ol_list` (object)
1559
-
1560
- Properties of the `ol_list` object:
1561
-
1562
- #### `disabled` (boolean)
1563
-
1564
- Indicates if the plugin is disabled or not
1565
-
1566
- ### `redo` (object)
1567
-
1568
- Properties of the `redo` object:
1569
-
1570
- #### `disabled` (boolean)
1571
-
1572
- Indicates if the plugin is disabled or not
1573
-
1574
- ### `strikethrough` (object)
1575
-
1576
- Properties of the `strikethrough` object:
1577
-
1578
- #### `disabled` (boolean)
1579
-
1580
- Indicates if the plugin is disabled or not
1581
-
1582
- ### `sub` (object)
1583
-
1584
- Properties of the `sub` object:
1585
-
1586
- #### `disabled` (boolean)
1587
-
1588
- Indicates if the plugin is disabled or not
1589
-
1590
- ### `sup` (object)
1591
-
1592
- Properties of the `sup` object:
1593
-
1594
- #### `disabled` (boolean)
1595
-
1596
- Indicates if the plugin is disabled or not
1597
-
1598
- ### `table` (object)
1599
-
1600
- Properties of the `table` object:
1601
-
1602
- #### `disabled` (boolean)
1603
-
1604
- Indicates if the plugin is disabled or not
1605
-
1606
- ### `ul_list` (object)
1607
-
1608
- Properties of the `ul_list` object:
1609
-
1610
- #### `disabled` (boolean)
1611
-
1612
- Indicates if the plugin is disabled or not
1613
-
1614
- ### `underline` (object)
1615
-
1616
- Properties of the `underline` object:
1617
-
1618
- #### `disabled` (boolean)
1619
-
1620
- Indicates if the plugin is disabled or not
1621
-
1622
- ### `undo` (object)
1623
-
1624
- Properties of the `undo` object:
1625
-
1626
- #### `disabled` (boolean)
1627
-
1628
- Indicates if the plugin is disabled or not
1629
-
1630
- ## `EditableHtmlButtonConfigure` (object)
1631
-
1632
- Properties of the `EditableHtmlButtonConfigure` object:
1633
-
1634
- ### `disabled` (boolean)
1635
-
1636
- Indicates if the plugin is disabled or not
1637
-
1638
- ## `CustomPlugin` (object)
1639
-
1640
- Properties of the `CustomPlugin` object:
1641
-
1642
- ### `event` (string, required)
1643
-
1644
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1645
- PIE will emit the event prefixed with "PIE-".
1646
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1647
-
1648
- ### `iconAlt` (string, required)
1649
-
1650
- The alt for the custom button icon
1651
-
1652
- ### `iconType` (string, required)
1653
-
1654
- The icon type.
1655
- Currently, only "SVG" is supported.
1656
-
1657
- ### `icon` (string, required)
1658
-
1659
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1660
-
1661
- ## `ConfigureProp` (object)
1662
-
1663
- Properties of the `ConfigureProp` object:
1664
-
1665
- ### `settings` (boolean)
1666
-
1667
- Indicates if the item has to be displayed in the Settings Panel
1668
-
1669
- ### `label` (string)
1670
-
1671
- Indicates the label for the item that has to be displayed in the Settings Panel
1672
-
1673
- ## `EditableHtmlPluginConfigureRequired` (object)
1674
-
1675
- Properties of the `EditableHtmlPluginConfigureRequired` object:
1676
-
1677
- ### `inputConfiguration` (object)
1678
-
1679
- Properties of the `inputConfiguration` object:
1680
-
1681
- #### `math` (object)
1682
-
1683
- Properties of the `math` object:
1684
-
1685
- ##### `disabled` (boolean)
1686
-
1687
- Indicates if the plugin is disabled or not
1688
-
1689
- #### `audio` (object)
1690
-
1691
- Properties of the `audio` object:
1692
-
1693
- ##### `disabled` (boolean)
1694
-
1695
- Indicates if the plugin is disabled or not
1696
-
1697
- #### `video` (object)
1698
-
1699
- Properties of the `video` object:
1700
-
1701
- ##### `disabled` (boolean)
1702
-
1703
- Indicates if the plugin is disabled or not
1704
-
1705
- #### `image` (object)
1706
-
1707
- Properties of the `image` object:
1708
-
1709
- ##### `disabled` (boolean)
1710
-
1711
- Indicates if the plugin is disabled or not
1712
-
1713
- #### `customPlugins` (array)
1714
-
1715
- An array of objects that determine custom plugins.
1716
- 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).
1717
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1718
-
1719
- The object is an array with all elements of the type `object`.
1720
-
1721
- The array object has the following properties:
1722
-
1723
- ##### `event` (string, required)
1724
-
1725
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1726
- PIE will emit the event prefixed with "PIE-".
1727
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1728
-
1729
- ##### `iconAlt` (string, required)
1730
-
1731
- The alt for the custom button icon
1732
-
1733
- ##### `iconType` (string, required)
1734
-
1735
- The icon type.
1736
- Currently, only "SVG" is supported.
1737
-
1738
- ##### `icon` (string, required)
1739
-
1740
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1741
-
1742
- #### `blockquote` (object)
1743
-
1744
- Properties of the `blockquote` object:
1745
-
1746
- ##### `disabled` (boolean)
1747
-
1748
- Indicates if the plugin is disabled or not
1749
-
1750
- #### `h3` (object)
1751
-
1752
- Properties of the `h3` object:
1753
-
1754
- ##### `disabled` (boolean)
1755
-
1756
- Indicates if the plugin is disabled or not
1757
-
1758
- #### `characters` (object)
1759
-
1760
- Properties of the `characters` object:
1761
-
1762
- ##### `disabled` (boolean)
1763
-
1764
- Indicates if the plugin is disabled or not
1765
-
1766
- #### `bold` (object)
1767
-
1768
- Properties of the `bold` object:
1769
-
1770
- ##### `disabled` (boolean)
1771
-
1772
- Indicates if the plugin is disabled or not
1773
-
1774
- #### `html` (object)
1775
-
1776
- Properties of the `html` object:
1777
-
1778
- ##### `disabled` (boolean)
1779
-
1780
- Indicates if the plugin is disabled or not
1781
-
1782
- #### `italic` (object)
1783
-
1784
- Properties of the `italic` object:
1785
-
1786
- ##### `disabled` (boolean)
1787
-
1788
- Indicates if the plugin is disabled or not
1789
-
1790
- #### `ol_list` (object)
1791
-
1792
- Properties of the `ol_list` object:
1793
-
1794
- ##### `disabled` (boolean)
1795
-
1796
- Indicates if the plugin is disabled or not
1797
-
1798
- #### `redo` (object)
1799
-
1800
- Properties of the `redo` object:
1801
-
1802
- ##### `disabled` (boolean)
1803
-
1804
- Indicates if the plugin is disabled or not
1805
-
1806
- #### `strikethrough` (object)
1807
-
1808
- Properties of the `strikethrough` object:
1809
-
1810
- ##### `disabled` (boolean)
1811
-
1812
- Indicates if the plugin is disabled or not
1813
-
1814
- #### `sub` (object)
1815
-
1816
- Properties of the `sub` object:
1817
-
1818
- ##### `disabled` (boolean)
1819
-
1820
- Indicates if the plugin is disabled or not
1821
-
1822
- #### `sup` (object)
1823
-
1824
- Properties of the `sup` object:
1825
-
1826
- ##### `disabled` (boolean)
1827
-
1828
- Indicates if the plugin is disabled or not
1829
-
1830
- #### `table` (object)
1831
-
1832
- Properties of the `table` object:
1833
-
1834
- ##### `disabled` (boolean)
1835
-
1836
- Indicates if the plugin is disabled or not
1837
-
1838
- #### `ul_list` (object)
1839
-
1840
- Properties of the `ul_list` object:
1841
-
1842
- ##### `disabled` (boolean)
1843
-
1844
- Indicates if the plugin is disabled or not
1845
-
1846
- #### `underline` (object)
1847
-
1848
- Properties of the `underline` object:
1849
-
1850
- ##### `disabled` (boolean)
1851
-
1852
- Indicates if the plugin is disabled or not
1853
-
1854
- #### `undo` (object)
1855
-
1856
- Properties of the `undo` object:
1857
-
1858
- ##### `disabled` (boolean)
1859
-
1860
- Indicates if the plugin is disabled or not
1861
-
1862
- ### `required` (boolean)
1863
-
1864
- Indicates if the item is required and the value cannot be empty
1865
-
1866
- ### `settings` (boolean)
1867
-
1868
- Indicates if the item has to be displayed in the Settings Panel
1869
-
1870
- ### `label` (string)
1871
-
1872
- Indicates the label for the item that has to be displayed in the Settings Panel
1873
-
1874
- ## `EditableHtmlPluginConfigure` (object)
1875
-
1876
- Properties of the `EditableHtmlPluginConfigure` object:
1877
-
1878
- ### `inputConfiguration` (object)
1879
-
1880
- Properties of the `inputConfiguration` object:
1881
-
1882
- #### `math` (object)
1883
-
1884
- Properties of the `math` object:
1885
-
1886
- ##### `disabled` (boolean)
1887
-
1888
- Indicates if the plugin is disabled or not
1889
-
1890
- #### `audio` (object)
1891
-
1892
- Properties of the `audio` object:
1893
-
1894
- ##### `disabled` (boolean)
1895
-
1896
- Indicates if the plugin is disabled or not
1897
-
1898
- #### `video` (object)
1899
-
1900
- Properties of the `video` object:
1901
-
1902
- ##### `disabled` (boolean)
1903
-
1904
- Indicates if the plugin is disabled or not
1905
-
1906
- #### `image` (object)
1907
-
1908
- Properties of the `image` object:
1909
-
1910
- ##### `disabled` (boolean)
1911
-
1912
- Indicates if the plugin is disabled or not
1913
-
1914
- #### `customPlugins` (array)
1915
-
1916
- An array of objects that determine custom plugins.
1917
- 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).
1918
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1919
-
1920
- The object is an array with all elements of the type `object`.
1921
-
1922
- The array object has the following properties:
1923
-
1924
- ##### `event` (string, required)
1925
-
1926
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1927
- PIE will emit the event prefixed with "PIE-".
1928
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1929
-
1930
- ##### `iconAlt` (string, required)
1931
-
1932
- The alt for the custom button icon
1933
-
1934
- ##### `iconType` (string, required)
1935
-
1936
- The icon type.
1937
- Currently, only "SVG" is supported.
1938
-
1939
- ##### `icon` (string, required)
1940
-
1941
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1942
-
1943
- #### `blockquote` (object)
1944
-
1945
- Properties of the `blockquote` object:
1946
-
1947
- ##### `disabled` (boolean)
1948
-
1949
- Indicates if the plugin is disabled or not
1950
-
1951
- #### `h3` (object)
1952
-
1953
- Properties of the `h3` object:
1954
-
1955
- ##### `disabled` (boolean)
1956
-
1957
- Indicates if the plugin is disabled or not
1958
-
1959
- #### `characters` (object)
1960
-
1961
- Properties of the `characters` object:
1962
-
1963
- ##### `disabled` (boolean)
1964
-
1965
- Indicates if the plugin is disabled or not
1966
-
1967
- #### `bold` (object)
1968
-
1969
- Properties of the `bold` object:
1970
-
1971
- ##### `disabled` (boolean)
1972
-
1973
- Indicates if the plugin is disabled or not
1974
-
1975
- #### `html` (object)
1976
-
1977
- Properties of the `html` object:
1978
-
1979
- ##### `disabled` (boolean)
1980
-
1981
- Indicates if the plugin is disabled or not
1982
-
1983
- #### `italic` (object)
1984
-
1985
- Properties of the `italic` object:
1986
-
1987
- ##### `disabled` (boolean)
1988
-
1989
- Indicates if the plugin is disabled or not
1990
-
1991
- #### `ol_list` (object)
1992
-
1993
- Properties of the `ol_list` object:
1994
-
1995
- ##### `disabled` (boolean)
1996
-
1997
- Indicates if the plugin is disabled or not
1998
-
1999
- #### `redo` (object)
2000
-
2001
- Properties of the `redo` object:
2002
-
2003
- ##### `disabled` (boolean)
2004
-
2005
- Indicates if the plugin is disabled or not
2006
-
2007
- #### `strikethrough` (object)
2008
-
2009
- Properties of the `strikethrough` object:
2010
-
2011
- ##### `disabled` (boolean)
2012
-
2013
- Indicates if the plugin is disabled or not
2014
-
2015
- #### `sub` (object)
2016
-
2017
- Properties of the `sub` object:
2018
-
2019
- ##### `disabled` (boolean)
2020
-
2021
- Indicates if the plugin is disabled or not
2022
-
2023
- #### `sup` (object)
2024
-
2025
- Properties of the `sup` object:
2026
-
2027
- ##### `disabled` (boolean)
2028
-
2029
- Indicates if the plugin is disabled or not
2030
-
2031
- #### `table` (object)
2032
-
2033
- Properties of the `table` object:
2034
-
2035
- ##### `disabled` (boolean)
2036
-
2037
- Indicates if the plugin is disabled or not
2038
-
2039
- #### `ul_list` (object)
2040
-
2041
- Properties of the `ul_list` object:
2042
-
2043
- ##### `disabled` (boolean)
2044
-
2045
- Indicates if the plugin is disabled or not
2046
-
2047
- #### `underline` (object)
2048
-
2049
- Properties of the `underline` object:
2050
-
2051
- ##### `disabled` (boolean)
2052
-
2053
- Indicates if the plugin is disabled or not
2054
-
2055
- #### `undo` (object)
2056
-
2057
- Properties of the `undo` object:
2058
-
2059
- ##### `disabled` (boolean)
2060
-
2061
- Indicates if the plugin is disabled or not
2062
-
2063
- ### `settings` (boolean)
2064
-
2065
- Indicates if the item has to be displayed in the Settings Panel
2066
-
2067
- ### `label` (string)
2068
-
2069
- Indicates the label for the item that has to be displayed in the Settings Panel
2070
-
2071
- ## `ConfigureMathMLProp` (object)
2072
-
2073
- Properties of the `ConfigureMathMLProp` object:
2074
-
2075
- ### `mmlOutput` (number)
2076
-
2077
- Indicates if model should have mathML output instead of latex
2078
-
2079
- ### `mmlEditing` (number)
2080
-
2081
- Indicates if mathML that's already in model should be editable
2082
-
2083
- ## `ConfigureMaxImageDimensionsProp` (object)
2084
-
2085
- Properties of the `ConfigureMaxImageDimensionsProp` object:
2086
-
2087
- ### `teacherInstructions` (number)
2088
-
2089
- Indicates the max dimension for images in teacher instructions
2090
-
2091
- ### `prompt` (number)
2092
-
2093
- Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
2094
-
2095
- ### `rationale` (number)
2096
-
2097
- Indicates the max dimension for images in rationale
2098
-
2099
- ### `choices` (number)
2100
-
2101
- Indicates the max dimension for images in choices
2102
-
2103
- ### `rowLabel` (number)
2104
-
2105
- Indicates the max dimension for images in row labels
2106
-
2107
- ### `categoryLabel` (number)
2108
-
2109
- Indicates the max dimension for images in category labels
2110
-
2111
- ## `ConfigurePropWithEnabled` (object)
2112
-
2113
- Properties of the `ConfigurePropWithEnabled` object:
2114
-
2115
- ### `enabled` (boolean)
2116
-
2117
- Indicates the value of the item if it affects config-ui
2118
- (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
2119
-
2120
- ### `settings` (boolean)
2121
-
2122
- Indicates if the item has to be displayed in the Settings Panel
2123
-
2124
- ### `label` (string)
2125
-
2126
- Indicates the label for the item that has to be displayed in the Settings Panel
2127
-
2128
- ## `ConfigureLanguageOptionsProp` (object)
2129
-
2130
- Properties of the `ConfigureLanguageOptionsProp` object:
2131
-
2132
- ### `value` (string, required)
2133
-
2134
- Value of the language option
2135
-
2136
- ### `label` (string, required)
2137
-
2138
- Label of the language option