lido-player 0.0.2-beta-17 → 0.0.2-beta-18-dev

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 (233) hide show
  1. package/LICENSE +21 -21
  2. package/dist/cjs/{decode-BPWgujpW.js → decode-DUZYNXIv.js} +1 -1
  3. package/dist/cjs/{index-BnfJD-Dp.js → index-BEjUmVtH.js} +185 -86
  4. package/dist/cjs/{index-CACb9dlg.js → index-DnqQXD5x.js} +53 -12
  5. package/dist/cjs/index.cjs.js +2 -2
  6. package/dist/cjs/lido-avatar_22.cjs.entry.js +61 -68
  7. package/dist/cjs/lido-player.cjs.js +3 -3
  8. package/dist/cjs/loader.cjs.js +2 -2
  9. package/dist/collection/collection-manifest.json +1 -1
  10. package/dist/collection/components/avatar/lido-avatar.css +4 -4
  11. package/dist/collection/components/avatar/lido-avatar.js +1 -1
  12. package/dist/collection/components/avatar/lido-avatar.tsx +207 -207
  13. package/dist/collection/components/avatar/readme.md +49 -49
  14. package/dist/collection/components/calculator/lido-calculator.css +89 -89
  15. package/dist/collection/components/calculator/lido-calculator.js +2 -2
  16. package/dist/collection/components/canvas/lido-canvas.css +33 -33
  17. package/dist/collection/components/canvas/lido-canvas.js +1 -1
  18. package/dist/collection/components/cell/lido-cell.css +100 -100
  19. package/dist/collection/components/cell/lido-cell.js +12 -12
  20. package/dist/collection/components/column/lido-col.css +19 -19
  21. package/dist/collection/components/column/lido-col.js +6 -6
  22. package/dist/collection/components/container/lido-container.css +10 -10
  23. package/dist/collection/components/container/lido-container.js +8 -8
  24. package/dist/collection/components/flashCard/lido-flash-card.css +28 -28
  25. package/dist/collection/components/flashCard/lido-flash-card.js +4 -4
  26. package/dist/collection/components/float/lido-float.css +30 -30
  27. package/dist/collection/components/float/lido-float.js +2 -2
  28. package/dist/collection/components/home/lido-home.css +309 -309
  29. package/dist/collection/components/home/lido-home.js +5 -5
  30. package/dist/collection/components/image/lido-image.css +17 -17
  31. package/dist/collection/components/image/lido-image.js +6 -6
  32. package/dist/collection/components/keyboard/lido-keyboard.css +38 -38
  33. package/dist/collection/components/keyboard/lido-keyboard.js +3 -3
  34. package/dist/collection/components/mathMatrix/lido-math-matrix.css +56 -56
  35. package/dist/collection/components/mathMatrix/lido-math-matrix.js +1 -1
  36. package/dist/collection/components/position/lido-pos.css +16 -16
  37. package/dist/collection/components/position/lido-pos.js +2 -2
  38. package/dist/collection/components/random/lido-random.css +8 -8
  39. package/dist/collection/components/random/lido-random.js +2 -2
  40. package/dist/collection/components/root/lido-root.js +5 -5
  41. package/dist/collection/components/row/lido-row.css +10 -10
  42. package/dist/collection/components/row/lido-row.js +6 -6
  43. package/dist/collection/components/scale/assets/Shadow.svg +9 -9
  44. package/dist/collection/components/scale/lido-balance.css +145 -145
  45. package/dist/collection/components/scale/lido-balance.js +13 -13
  46. package/dist/collection/components/shape/lido-shape.css +216 -216
  47. package/dist/collection/components/shape/lido-shape.js +6 -6
  48. package/dist/collection/components/slideFill/lido-slide-fill.css +3 -3
  49. package/dist/collection/components/slideFill/lido-slide-fill.js +13 -13
  50. package/dist/collection/components/text/lido-text.css +53 -53
  51. package/dist/collection/components/text/lido-text.js +31 -6
  52. package/dist/collection/components/trace/assets/Tracing-hand.svg +8 -8
  53. package/dist/collection/components/trace/lido-trace.css +97 -97
  54. package/dist/collection/components/trace/lido-trace.js +22 -35
  55. package/dist/collection/components/wrap/lido-wrap.css +18 -18
  56. package/dist/collection/components/wrap/lido-wrap.js +6 -6
  57. package/dist/collection/css/animation.css +211 -211
  58. package/dist/collection/css/index.css +315 -315
  59. package/dist/collection/stories/Templates/Fill-Up/fill-up.stories.js +61 -61
  60. package/dist/collection/stories/Templates/LetterPairing/LetterPairing.stories.js +123 -123
  61. package/dist/collection/stories/Templates/RocketGame/rocketGame.stories.js +48 -48
  62. package/dist/collection/stories/Templates/Tag/tagGame.stories.js +39 -39
  63. package/dist/collection/stories/Templates/arrangeLetters/arrangeLetters.stories.js +44 -44
  64. package/dist/collection/stories/Templates/balancing/balancing.stories.js +35 -35
  65. package/dist/collection/stories/Templates/balloonPop/balloonPop.stories.js +38 -38
  66. package/dist/collection/stories/Templates/blender/blender.stories.js +63 -59
  67. package/dist/collection/stories/Templates/bubbleType/bubbleType.stories.js +42 -42
  68. package/dist/collection/stories/Templates/calculator/calculator.stories.js +28 -28
  69. package/dist/collection/stories/Templates/categorize/categorize.stories.js +37 -37
  70. package/dist/collection/stories/Templates/categorize2/categorize2.stories.js +67 -67
  71. package/dist/collection/stories/Templates/checker-block/checkerBlock.stories.js +29 -29
  72. package/dist/collection/stories/Templates/checkerBlock/checkerBlock.stories.js +13 -13
  73. package/dist/collection/stories/Templates/create-sentence/createSentence.stories.js +74 -74
  74. package/dist/collection/stories/Templates/dragAndDrop/drag-drop.stories.js +69 -69
  75. package/dist/collection/stories/Templates/fillAnswer/fill-answer.stories.js +43 -43
  76. package/dist/collection/stories/Templates/fillBlank/fill-blank.stories.js +282 -282
  77. package/dist/collection/stories/Templates/foodJar/food-jar.stories.js +35 -35
  78. package/dist/collection/stories/Templates/grid/grid.stories.js +118 -118
  79. package/dist/collection/stories/Templates/gridGame/grid-game.stories.js +57 -57
  80. package/dist/collection/stories/Templates/imageMatch/imageMatch.stories.js +44 -44
  81. package/dist/collection/stories/Templates/jumpSentence/jumpSentence.stories.js +41 -41
  82. package/dist/collection/stories/Templates/letterboard/letterboard.stories.js +183 -183
  83. package/dist/collection/stories/Templates/makeSentence/make-sentence.stories.js +36 -36
  84. package/dist/collection/stories/Templates/matchBox/matchBox.stories.js +69 -69
  85. package/dist/collection/stories/Templates/matchBox/matchBox2.stories.js +84 -84
  86. package/dist/collection/stories/Templates/matchingCard/matching-card.stories.js +31 -31
  87. package/dist/collection/stories/Templates/multipleOption/mcqWithQuestionImage.stories.js +112 -112
  88. package/dist/collection/stories/Templates/multipleOption/multiple-option.stories.js +47 -47
  89. package/dist/collection/stories/Templates/multiplyBeeds/multiplyBeeds.stories.js +57 -57
  90. package/dist/collection/stories/Templates/nimbleTable/nimbleTable.stories.js +53 -53
  91. package/dist/collection/stories/Templates/numberBoard/numberBoard.stories.js +46 -46
  92. package/dist/collection/stories/Templates/numberBoardTwo/numberBoardTwo.stories.js +45 -45
  93. package/dist/collection/stories/Templates/numberIdentification/numberIdentificationimageTotext.stories.js +56 -56
  94. package/dist/collection/stories/Templates/numberIdentification/numberIdentificationtextTotext.stories.js +53 -53
  95. package/dist/collection/stories/Templates/numberPair/numberPair.stories.js +127 -127
  96. package/dist/collection/stories/Templates/openwindow/openwindow.stories.js +47 -47
  97. package/dist/collection/stories/Templates/openwindow/openwindow2.stories.js +38 -38
  98. package/dist/collection/stories/Templates/order-tractor/order-tractor-ascending-order.stories.js +97 -97
  99. package/dist/collection/stories/Templates/order-tractor/order-tractor.stories.js +90 -90
  100. package/dist/collection/stories/Templates/palEgmaCalculateSum/palEgmaMultiOption.stories.js +63 -63
  101. package/dist/collection/stories/Templates/palEgmaCalculateSum/palEgmaSumTogether.stories.js +45 -45
  102. package/dist/collection/stories/Templates/palEgmaPatternMatching/palEgmaPatternMatching.stories.js +63 -63
  103. package/dist/collection/stories/Templates/palEgmaWordProblem/palEgmaWordProblem.stories.js +79 -79
  104. package/dist/collection/stories/Templates/palEgraInventedSpelling/pal_egra_invented_spelling_schema.stories.js +32 -32
  105. package/dist/collection/stories/Templates/palEgraMCQWithImage/palEgraMCQWithImage.stories.js +42 -42
  106. package/dist/collection/stories/Templates/palEgraOptionWithAudio/palEgraOptionWithAudio.stories.js +63 -63
  107. package/dist/collection/stories/Templates/palEgraStoryMaking/pal_egra_story_making.stories.js +44 -44
  108. package/dist/collection/stories/Templates/palEgraTemplate1/palEgraLetterIdentification.stories.js +34 -34
  109. package/dist/collection/stories/Templates/palEgraWordMatch/palEgraWordMatch.stories.js +52 -52
  110. package/dist/collection/stories/Templates/palEgra_OddOneOut/palEgra_oddOneOut.stories.js +33 -33
  111. package/dist/collection/stories/Templates/palEgra_arrange_pictures/palEgra_arrange_pictures.stories.js +40 -40
  112. package/dist/collection/stories/Templates/palEgra_build_word/palEgra_build_word.stories.js +48 -48
  113. package/dist/collection/stories/Templates/palEgra_word_formation/palEgra_WordFormation.stories.js +48 -48
  114. package/dist/collection/stories/Templates/palStorytale/palStorytale.stories.js +18 -18
  115. package/dist/collection/stories/Templates/phonic-tractor/phonic-tractor.stories.js +44 -44
  116. package/dist/collection/stories/Templates/pictureClues/pictureClues.stories.js +34 -34
  117. package/dist/collection/stories/Templates/pictureWordMatch/pictureWordMatch1.stories.js +36 -36
  118. package/dist/collection/stories/Templates/pictureWordMatch/pictureWordMatch2.stories.js +30 -30
  119. package/dist/collection/stories/Templates/picturemeaning/pictureMeaningCocos.stories.js +20 -20
  120. package/dist/collection/stories/Templates/puzzleGame/puzzleGame.stories.js +17 -17
  121. package/dist/collection/stories/Templates/questionBoard/questionBoard.stories.js +58 -58
  122. package/dist/collection/stories/Templates/quizLiteracy/quizLiteracy.stories.js +50 -50
  123. package/dist/collection/stories/Templates/quizLiteracy/quizLiteracyImageWithText.stories.js +36 -36
  124. package/dist/collection/stories/Templates/quizLiteracy/quizLiteracyImageWord.stories.js +43 -43
  125. package/dist/collection/stories/Templates/quizMaths/quizMaths.stories.js +631 -631
  126. package/dist/collection/stories/Templates/reorder/reorder.stories.js +63 -63
  127. package/dist/collection/stories/Templates/rowBlocks/rowBlocks.stories.js +47 -47
  128. package/dist/collection/stories/Templates/sentenceMatch/sentenceMatch.stories.js +29 -29
  129. package/dist/collection/stories/Templates/sequenceBox/sequenceBox1.stories.js +64 -64
  130. package/dist/collection/stories/Templates/sequenceBox/sequenceBox2.stories.js +62 -62
  131. package/dist/collection/stories/Templates/shapePair/shape-pair.stories.js +106 -106
  132. package/dist/collection/stories/Templates/shapeTractor/shape-tractor.stories.js +50 -50
  133. package/dist/collection/stories/Templates/spellDoor/spellDoor.stories.js +41 -41
  134. package/dist/collection/stories/Templates/storyTale/storyTale.stories.js +39 -39
  135. package/dist/collection/stories/Templates/substraction/substractionWithimg.stories.js +62 -62
  136. package/dist/collection/stories/Templates/substraction/substractionWithoutImg.stories.js +42 -42
  137. package/dist/collection/stories/Templates/sumTogether/sumTogether.stories.js +50 -50
  138. package/dist/collection/stories/Templates/tenBox/tenBox.stories.js +88 -88
  139. package/dist/collection/stories/Templates/total/total.stories.js +28 -28
  140. package/dist/collection/stories/Templates/wordBuilding/wordBuildingwithimg.stories.js +35 -35
  141. package/dist/collection/stories/Templates/wordBuilding/wordBuildingwithoutimg.stories.js +34 -34
  142. package/dist/collection/stories/Templates/writeCard/writeCard.stories.js +31 -31
  143. package/dist/collection/stories/Templates/writeLetter/writeLetter.stories.js +58 -58
  144. package/dist/collection/stories/Templates/writeNumber/writeNumber.stories.js +44 -44
  145. package/dist/collection/stories/Templates/writeSet/writeSet.stories.js +31 -31
  146. package/dist/collection/stories/Templates/writeWord/writeWord.stories.js +34 -34
  147. package/dist/collection/stories/components/flash-card.stories.js +48 -48
  148. package/dist/collection/stories/components/keyboard.stories.js +10 -10
  149. package/dist/collection/stories/components/slider.stories.js +4 -4
  150. package/dist/collection/stories/components/trace.stories.js +5 -5
  151. package/dist/collection/utils/utils.js +26 -17
  152. package/dist/collection/utils/utilsHandlers/dragDropHandler.js +36 -16
  153. package/dist/collection/utils/utilsHandlers/highlightHandler.js +54 -54
  154. package/dist/collection/utils/utilsHandlers/slideHandler.js +80 -23
  155. package/dist/collection/utils/utilsHandlers/sortHandler.js +10 -10
  156. package/dist/components/index.js +1 -1
  157. package/dist/components/lido-avatar.js +1 -1
  158. package/dist/components/lido-balance.js +1 -1
  159. package/dist/components/lido-calculator.js +1 -1
  160. package/dist/components/lido-canvas.js +1 -1
  161. package/dist/components/lido-cell.js +1 -1
  162. package/dist/components/lido-col.js +1 -1
  163. package/dist/components/lido-container.js +1 -1
  164. package/dist/components/lido-flash-card.js +1 -1
  165. package/dist/components/lido-float.js +1 -1
  166. package/dist/components/lido-home.js +1 -1
  167. package/dist/components/lido-keyboard.js +1 -1
  168. package/dist/components/lido-math-matrix.js +1 -1
  169. package/dist/components/lido-pos.js +1 -1
  170. package/dist/components/lido-random.js +1 -1
  171. package/dist/components/lido-root.js +1 -1
  172. package/dist/components/lido-row.js +1 -1
  173. package/dist/components/lido-shape.js +1 -1
  174. package/dist/components/lido-slide-fill.js +1 -1
  175. package/dist/components/lido-text.js +1 -1
  176. package/dist/components/lido-trace.js +1 -1
  177. package/dist/components/lido-wrap.js +1 -1
  178. package/dist/components/{p-CCR42e0i.js → p-BE25wHoo.js} +1 -1
  179. package/dist/components/p-BNNX1Pew.js +12 -0
  180. package/dist/components/p-BSV5U72F.js +1 -0
  181. package/dist/components/{p-CTlcpv4a.js → p-BfwUqpXc.js} +1 -1
  182. package/dist/components/{p-CgsPIpg0.js → p-Bw-OC9iR.js} +1 -1
  183. package/dist/components/{p-C5WmmkI6.js → p-CPYnt0P-.js} +1 -1
  184. package/dist/components/p-CTlwn9r7.js +1 -0
  185. package/dist/components/{p-CIbBOu51.js → p-Cj-6tqzU.js} +1 -1
  186. package/dist/components/{p-BfqihbR6.js → p-CjdDpXfk.js} +1 -1
  187. package/dist/components/{p-BeRr8u5m.js → p-CwDTdXe5.js} +1 -1
  188. package/dist/components/{p-CXHPZN3m.js → p-CyGxEcn7.js} +1 -1
  189. package/dist/components/p-D-B1groh.js +1 -0
  190. package/dist/components/{p-DuvxecDX.js → p-D54c-ybm.js} +1 -1
  191. package/dist/components/p-DbR5sNOj.js +1 -0
  192. package/dist/components/{p-B8nzzM8c.js → p-DdQ1eqJr.js} +1 -1
  193. package/dist/components/{p-CxkH5UIf.js → p-SPZTb5fI.js} +1 -1
  194. package/dist/components/{p-BBHM059l.js → p-Sl9R-E6h.js} +1 -1
  195. package/dist/components/p-leIEepjl.js +1 -0
  196. package/dist/components/{p-C70ykycD.js → p-useuhkjH.js} +1 -1
  197. package/dist/components/{p-BXvoOUIv.js → p-yT7udDfd.js} +1 -1
  198. package/dist/esm/{decode-To5V_Qqp.js → decode-BgBfbPZu.js} +1 -1
  199. package/dist/esm/{index-Dnvog_Mm.js → index-BeHFCsWf.js} +53 -12
  200. package/dist/esm/{index-CEJsA_x_.js → index-D-29PaRa.js} +185 -86
  201. package/dist/esm/index.js +2 -2
  202. package/dist/esm/lido-avatar_22.entry.js +61 -68
  203. package/dist/esm/lido-player.js +4 -4
  204. package/dist/esm/loader.js +3 -3
  205. package/dist/lido-player/assets/Shadow.svg +9 -9
  206. package/dist/lido-player/assets/Tracing-hand.svg +8 -8
  207. package/dist/lido-player/index.esm.js +1 -1
  208. package/dist/lido-player/lido-avatar.css +4 -4
  209. package/dist/lido-player/lido-avatar.tsx +207 -207
  210. package/dist/lido-player/lido-player.css +7 -7
  211. package/dist/lido-player/lido-player.esm.js +1 -1
  212. package/dist/lido-player/{p-3b6e3b51.entry.js → p-856e1956.entry.js} +3 -3
  213. package/dist/lido-player/{p-DUx4nii8.js → p-BA2X6O7O.js} +1 -1
  214. package/dist/lido-player/p-BeHFCsWf.js +3 -0
  215. package/dist/lido-player/p-TuBmCgtK.js +1 -0
  216. package/dist/lido-player/readme.md +49 -49
  217. package/dist/types/components/text/lido-text.d.ts +6 -1
  218. package/dist/types/components/trace/lido-trace.d.ts +1 -1
  219. package/dist/types/components.d.ts +11 -0
  220. package/dist/types/stencil-public-runtime.d.ts +12 -0
  221. package/dist/types/types/json.d.ts +3 -3
  222. package/dist/types/utils/utilsHandlers/slideHandler.d.ts +5 -0
  223. package/loader/index.d.ts +1 -1
  224. package/package.json +74 -73
  225. package/readme.md +113 -113
  226. package/dist/components/p-CwIlwnQk.js +0 -1
  227. package/dist/components/p-DBbLGy4y.js +0 -12
  228. package/dist/components/p-DLyacZap.js +0 -1
  229. package/dist/components/p-DONbWJGn.js +0 -1
  230. package/dist/components/p-DVTigdH_.js +0 -1
  231. package/dist/components/p-Dv1cIsyS.js +0 -1
  232. package/dist/lido-player/p-Dnvog_Mm.js +0 -2
  233. package/dist/lido-player/p-gkKsw3a6.js +0 -1
@@ -1,49 +1,49 @@
1
- # lido-avatar
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
12
- | `ariaHidden` | `aria-hidden` | The ARIA hidden attribute of the container. Used for accessibility to hide the element. | `string` | `''` |
13
- | `ariaLabel` | `aria-label` | The ARIA label of the container. Used for accessibility to indicate the purpose of the element. | `string` | `''` |
14
- | `audio` | `audio` | Audio file URL or identifier for sound that will be associated with the column. | `string` | `''` |
15
- | `bgColor` | `bg-color` | The background color of the column (CSS color value, e.g., '#FFFFFF', 'blue'). | `string` | `''` |
16
- | `delayVisible` | `delay-visible` | Delay in milliseconds to make the cell visible after mount. | `string` | `''` |
17
- | `height` | `height` | The height of the column component (CSS value, e.g., '100px', '50%'). | `string` | `''` |
18
- | `id` | `id` | The unique identifier for the column component. | `string` | `''` |
19
- | `onCorrect` | `on-correct` | Event handler for a Correct matching action, which can be used to hide the column or trigger other custom logic. | `string` | `''` |
20
- | `onEntry` | `on-entry` | Event handler for when the column is entered, which can be used to initiate specific behaviors on entry. | `string` | `''` |
21
- | `onInCorrect` | `on-in-correct` | Event handler for an Incorrect matching action, which can be used to trigger custom logic when the action is incorrect. | `string` | `''` |
22
- | `onTouch` | `on-touch` | Event handler for a touch event, where a custom function can be triggered when the column is touched. | `string` | `''` |
23
- | `src` | `src` | Source URL of the Rive (.riv) file | `string` | `''` |
24
- | `tabIndex` | `tab-index` | The tab index value, used to set the tab order of the column for keyboard navigation. | `number` | `0` |
25
- | `type` | `type` | Defines the type of the column, which can be used for styling or specific logic handling. | `string` | `''` |
26
- | `value` | `value` | The value associated with the column component. Typically used for internal logic. | `string` | `''` |
27
- | `visible` | `visible` | A boolean that controls whether the column is visible (`true`) or hidden (`false`). | `boolean` | `false` |
28
- | `width` | `width` | The width of the column component (CSS value, e.g., '100px', '50%'). | `string` | `'auto'` |
29
- | `x` | `x` | The x-coordinate (left position) of the column within its container (CSS value, e.g., '10px', '5vw'). | `string` | `'0px'` |
30
- | `y` | `y` | The y-coordinate (top position) of the column within its container (CSS value, e.g., '10px', '5vh'). | `string` | `'0px'` |
31
- | `z` | `z` | The z-index of the column to control stacking order. | `string` | `'0'` |
32
-
33
-
34
- ## Dependencies
35
-
36
- ### Used by
37
-
38
- - [lido-home](../home)
39
-
40
- ### Graph
41
- ```mermaid
42
- graph TD;
43
- lido-home --> lido-avatar
44
- style lido-avatar fill:#f9f,stroke:#333,stroke-width:4px
45
- ```
46
-
47
- ----------------------------------------------
48
-
49
- *Built with [StencilJS](https://stenciljs.com/)*
1
+ # lido-avatar
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
12
+ | `ariaHidden` | `aria-hidden` | The ARIA hidden attribute of the container. Used for accessibility to hide the element. | `string` | `''` |
13
+ | `ariaLabel` | `aria-label` | The ARIA label of the container. Used for accessibility to indicate the purpose of the element. | `string` | `''` |
14
+ | `audio` | `audio` | Audio file URL or identifier for sound that will be associated with the column. | `string` | `''` |
15
+ | `bgColor` | `bg-color` | The background color of the column (CSS color value, e.g., '#FFFFFF', 'blue'). | `string` | `''` |
16
+ | `delayVisible` | `delay-visible` | Delay in milliseconds to make the cell visible after mount. | `string` | `''` |
17
+ | `height` | `height` | The height of the column component (CSS value, e.g., '100px', '50%'). | `string` | `''` |
18
+ | `id` | `id` | The unique identifier for the column component. | `string` | `''` |
19
+ | `onCorrect` | `on-correct` | Event handler for a Correct matching action, which can be used to hide the column or trigger other custom logic. | `string` | `''` |
20
+ | `onEntry` | `on-entry` | Event handler for when the column is entered, which can be used to initiate specific behaviors on entry. | `string` | `''` |
21
+ | `onInCorrect` | `on-in-correct` | Event handler for an Incorrect matching action, which can be used to trigger custom logic when the action is incorrect. | `string` | `''` |
22
+ | `onTouch` | `on-touch` | Event handler for a touch event, where a custom function can be triggered when the column is touched. | `string` | `''` |
23
+ | `src` | `src` | Source URL of the Rive (.riv) file | `string` | `''` |
24
+ | `tabIndex` | `tab-index` | The tab index value, used to set the tab order of the column for keyboard navigation. | `number` | `0` |
25
+ | `type` | `type` | Defines the type of the column, which can be used for styling or specific logic handling. | `string` | `''` |
26
+ | `value` | `value` | The value associated with the column component. Typically used for internal logic. | `string` | `''` |
27
+ | `visible` | `visible` | A boolean that controls whether the column is visible (`true`) or hidden (`false`). | `boolean` | `false` |
28
+ | `width` | `width` | The width of the column component (CSS value, e.g., '100px', '50%'). | `string` | `'auto'` |
29
+ | `x` | `x` | The x-coordinate (left position) of the column within its container (CSS value, e.g., '10px', '5vw'). | `string` | `'0px'` |
30
+ | `y` | `y` | The y-coordinate (top position) of the column within its container (CSS value, e.g., '10px', '5vh'). | `string` | `'0px'` |
31
+ | `z` | `z` | The z-index of the column to control stacking order. | `string` | `'0'` |
32
+
33
+
34
+ ## Dependencies
35
+
36
+ ### Used by
37
+
38
+ - [lido-home](../home)
39
+
40
+ ### Graph
41
+ ```mermaid
42
+ graph TD;
43
+ lido-home --> lido-avatar
44
+ style lido-avatar fill:#f9f,stroke:#333,stroke-width:4px
45
+ ```
46
+
47
+ ----------------------------------------------
48
+
49
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -16,8 +16,13 @@ export declare class LidoText {
16
16
  id: string;
17
17
  /**
18
18
  * Value associated with the text element, typically used for internal logic or tracking.
19
- */
19
+ */
20
20
  value: string;
21
+ /**
22
+ * Number of drag elements required for count-based drop interactions.
23
+ * Used by the Blender template to determine the correct and incorrect border state.
24
+ */
25
+ requiredDrops: string;
21
26
  /**
22
27
  * The string of text to be displayed in the component.
23
28
  */
@@ -117,7 +117,7 @@ export declare class LidoTrace {
117
117
  fileIndex: number;
118
118
  isDragging: boolean;
119
119
  activePointerId: number | null;
120
- freeTraceUpdateCounter: number;
120
+ private freeTraceUpdateCounter;
121
121
  /** ───────────────────────────────────────────────────────────
122
122
  * NEW: idle‑timer + finger‑hint state
123
123
  * ─────────────────────────────────────────────────────────── */
@@ -2185,6 +2185,11 @@ export namespace Components {
2185
2185
  * @default ''
2186
2186
  */
2187
2187
  "padding": string;
2188
+ /**
2189
+ * Number of drag elements required for count-based drop interactions. Used by the Blender template to determine the correct and incorrect border state.
2190
+ * @default ''
2191
+ */
2192
+ "requiredDrops": string;
2188
2193
  /**
2189
2194
  * Controls whether the speak icon should appear directly on the top right corner of targeted element if it is true.
2190
2195
  * @default false
@@ -4904,6 +4909,11 @@ declare namespace LocalJSX {
4904
4909
  * @default ''
4905
4910
  */
4906
4911
  "padding"?: string;
4912
+ /**
4913
+ * Number of drag elements required for count-based drop interactions. Used by the Blender template to determine the correct and incorrect border state.
4914
+ * @default ''
4915
+ */
4916
+ "requiredDrops"?: string;
4907
4917
  /**
4908
4918
  * Controls whether the speak icon should appear directly on the top right corner of targeted element if it is true.
4909
4919
  * @default false
@@ -5647,6 +5657,7 @@ declare namespace LocalJSX {
5647
5657
  "showSpeakIcon": boolean;
5648
5658
  "id": string;
5649
5659
  "value": string;
5660
+ "requiredDrops": string;
5650
5661
  "string": string;
5651
5662
  "fontFamily": string;
5652
5663
  "fontSize": string;
@@ -1008,6 +1008,7 @@ export declare namespace JSXBase {
1008
1008
  onClose?: (event: Event) => void;
1009
1009
  open?: boolean;
1010
1010
  returnValue?: string;
1011
+ closedby?: 'any' | 'closerequest' | 'none';
1011
1012
  }
1012
1013
  interface EmbedHTMLAttributes<T> extends HTMLAttributes<T> {
1013
1014
  height?: number | string;
@@ -1045,6 +1046,8 @@ export declare namespace JSXBase {
1045
1046
  allowtransparency?: string | boolean;
1046
1047
  frameBorder?: number | string;
1047
1048
  frameborder?: number | string;
1049
+ fetchPriority?: 'high' | 'low' | 'auto';
1050
+ fetchpriority?: 'high' | 'low' | 'auto';
1048
1051
  importance?: 'low' | 'auto' | 'high';
1049
1052
  height?: number | string;
1050
1053
  loading?: 'lazy' | 'auto' | 'eager';
@@ -1067,6 +1070,8 @@ export declare namespace JSXBase {
1067
1070
  crossOrigin?: string;
1068
1071
  crossorigin?: string;
1069
1072
  decoding?: 'async' | 'auto' | 'sync';
1073
+ fetchPriority?: 'high' | 'low' | 'auto';
1074
+ fetchpriority?: 'high' | 'low' | 'auto';
1070
1075
  importance?: 'low' | 'auto' | 'high';
1071
1076
  height?: number | string;
1072
1077
  loading?: 'lazy' | 'auto' | 'eager';
@@ -1166,6 +1171,8 @@ export declare namespace JSXBase {
1166
1171
  }
1167
1172
  interface LinkHTMLAttributes<T> extends HTMLAttributes<T> {
1168
1173
  as?: string;
1174
+ fetchPriority?: 'high' | 'low' | 'auto';
1175
+ fetchpriority?: 'high' | 'low' | 'auto';
1169
1176
  href?: string;
1170
1177
  hrefLang?: string;
1171
1178
  hreflang?: string;
@@ -1289,6 +1296,8 @@ export declare namespace JSXBase {
1289
1296
  crossOrigin?: string;
1290
1297
  crossorigin?: string;
1291
1298
  defer?: boolean;
1299
+ fetchPriority?: 'high' | 'low' | 'auto';
1300
+ fetchpriority?: 'high' | 'low' | 'auto';
1292
1301
  importance?: 'low' | 'auto' | 'high';
1293
1302
  integrity?: string;
1294
1303
  nonce?: string;
@@ -1404,7 +1413,10 @@ export declare namespace JSXBase {
1404
1413
  tabIndex?: number;
1405
1414
  tabindex?: number | string;
1406
1415
  title?: string;
1416
+ translate?: 'yes' | 'no' | (string & {});
1407
1417
  popover?: string | null;
1418
+ focusgroup?: string;
1419
+ focusgroupstart?: boolean;
1408
1420
  inputMode?: string;
1409
1421
  inputmode?: string;
1410
1422
  enterKeyHint?: string;
@@ -1,4 +1,4 @@
1
- declare module "*.json" {
2
- const value: any;
3
- export default value;
1
+ declare module "*.json" {
2
+ const value: any;
3
+ export default value;
4
4
  }
@@ -1,2 +1,7 @@
1
1
  export declare const slideAnimation: () => Promise<void>;
2
2
  export declare function slidingWithScaling(element: HTMLElement): void;
3
+ export declare const getSlideValuesForValidation: (container: HTMLElement, slideElements: HTMLElement[]) => string[];
4
+ export declare const updateArrangeLettersCorrectness: (container: HTMLElement, slideValues: string[], objectiveValues: string[]) => void;
5
+ export declare const isArrangeLettersComplete: (slideValues: string[], objectiveString: string) => boolean;
6
+ export declare const updateReorderCorrectness: (container: HTMLElement, slideValues: string[], objectiveValues: string[]) => void;
7
+ export declare const isReorderComplete: (slideValues: string[], objectiveString: string) => boolean;
package/loader/index.d.ts CHANGED
@@ -8,7 +8,7 @@ export interface CustomElementsDefineOptions {
8
8
  ael?: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
9
9
  rel?: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
10
10
  }
11
- export declare function defineCustomElements(win?: Window, opts?: CustomElementsDefineOptions): void;
11
+ export declare function defineCustomElements(win?: Window, opts?: CustomElementsDefineOptions): Promise<void>;
12
12
  /**
13
13
  * @deprecated
14
14
  */
package/package.json CHANGED
@@ -1,73 +1,74 @@
1
- {
2
- "name": "lido-player",
3
- "version": "0.0.2-beta-17",
4
- "description": "Stencil Component For Lido Player",
5
- "main": "dist/index.cjs.js",
6
- "module": "dist/index.js",
7
- "types": "dist/types/index.d.ts",
8
- "collection": "dist/collection/collection-manifest.json",
9
- "collection:main": "dist/collection/index.js",
10
- "unpkg": "dist/lido-player/lido-player.esm.js",
11
- "exports": {
12
- ".": {
13
- "import": "./dist/lido-player/lido-player.esm.js",
14
- "require": "./dist/lido-player/lido-player.cjs.js"
15
- },
16
- "./my-component": {
17
- "import": "./dist/components/my-component.js",
18
- "types": "./dist/components/my-component.d.ts"
19
- },
20
- "./loader": {
21
- "import": "./loader/index.js",
22
- "require": "./loader/index.cjs",
23
- "types": "./loader/index.d.ts"
24
- }
25
- },
26
- "repository": {
27
- "type": "git",
28
- "url": "https://github.com/chimple/lido-player.git"
29
- },
30
- "files": [
31
- "dist/",
32
- "loader/"
33
- ],
34
- "scripts": {
35
- "build": "stencil build && npm run build-storybook",
36
- "start": "stencil build --dev --watch --serve",
37
- "dev": "npm run start",
38
- "test": "stencil test --spec --e2e",
39
- "test.watch": "stencil test --spec --e2e --watchAll",
40
- "generate": "stencil generate",
41
- "storybook": "storybook dev -p 6006",
42
- "build-storybook": "storybook build --output-dir www/storybook"
43
- },
44
- "devDependencies": {
45
- "@chromatic-com/storybook": "^3.2.6",
46
- "@stencil/core": "^4.7.0",
47
- "@storybook/addon-essentials": "^8.6.12",
48
- "@storybook/blocks": "^8.6.12",
49
- "@storybook/experimental-addon-test": "^8.6.12",
50
- "@storybook/test": "^8.6.12",
51
- "@storybook/web-components": "^8.6.12",
52
- "@storybook/web-components-vite": "^8.6.12",
53
- "@types/jest": "^29.5.14",
54
- "@types/node": "^16.18.11",
55
- "@types/react": "^19.1.2",
56
- "jest": "^29.7.0",
57
- "jest-cli": "^29.7.0",
58
- "lit": "^3.2.1",
59
- "storybook": "^8.6.12"
60
- },
61
- "license": "MIT",
62
- "dependencies": {
63
- "@rive-app/canvas": "2.32.0",
64
- "brotli": "^1.3.3",
65
- "css-filter-converter": "^1.0.110",
66
- "i18next": "^25.6.1",
67
- "i18next-browser-languagedetector": "^8.2.0",
68
- "jszip": "^3.10.1",
69
- "lido-player": "^0.0.2-alpha-77",
70
- "mathjs": "^14.4.0",
71
- "tinycolor2": "^1.6.0"
72
- }
73
- }
1
+ {
2
+ "name": "lido-player",
3
+ "version": "0.0.2-beta-18-dev",
4
+ "description": "Stencil Component For Lido Player",
5
+ "main": "dist/index.cjs.js",
6
+ "module": "dist/index.js",
7
+ "types": "dist/types/index.d.ts",
8
+ "collection": "dist/collection/collection-manifest.json",
9
+ "collection:main": "dist/collection/index.js",
10
+ "unpkg": "dist/lido-player/lido-player.esm.js",
11
+ "exports": {
12
+ ".": {
13
+ "import": "./dist/lido-player/lido-player.esm.js",
14
+ "require": "./dist/lido-player/lido-player.cjs.js"
15
+ },
16
+ "./my-component": {
17
+ "import": "./dist/components/my-component.js",
18
+ "types": "./dist/components/my-component.d.ts"
19
+ },
20
+ "./loader": {
21
+ "import": "./loader/index.js",
22
+ "require": "./loader/index.cjs",
23
+ "types": "./loader/index.d.ts"
24
+ }
25
+ },
26
+ "repository": {
27
+ "type": "git",
28
+ "url": "https://github.com/chimple/lido-player.git"
29
+ },
30
+ "files": [
31
+ "dist/",
32
+ "loader/"
33
+ ],
34
+ "scripts": {
35
+ "build": "stencil build && npm run build-storybook",
36
+ "start": "stencil build --dev --watch --serve",
37
+ "dev": "npm run start",
38
+ "test": "stencil test --spec --e2e",
39
+ "test.watch": "stencil test --spec --e2e --watchAll",
40
+ "generate": "stencil generate",
41
+ "storybook": "storybook dev -p 6006",
42
+ "build-storybook": "storybook build --output-dir www/storybook"
43
+ },
44
+ "devDependencies": {
45
+ "@chromatic-com/storybook": "^3.2.6",
46
+ "@stencil/core": "^4.7.0",
47
+ "@storybook/addon-essentials": "^8.6.12",
48
+ "@storybook/blocks": "^8.6.12",
49
+ "@storybook/experimental-addon-test": "^8.6.12",
50
+ "@storybook/test": "^8.6.12",
51
+ "@storybook/web-components": "^8.6.12",
52
+ "@storybook/web-components-vite": "^8.6.12",
53
+ "@types/jest": "^29.5.14",
54
+ "@types/node": "^16.18.11",
55
+ "@types/react": "^19.1.2",
56
+ "jest": "^29.7.0",
57
+ "jest-cli": "^29.7.0",
58
+ "lit": "^3.2.1",
59
+ "puppeteer": "^21.11.0",
60
+ "storybook": "^8.6.12"
61
+ },
62
+ "license": "MIT",
63
+ "dependencies": {
64
+ "@rive-app/canvas": "2.32.0",
65
+ "brotli": "^1.3.3",
66
+ "css-filter-converter": "^1.0.110",
67
+ "i18next": "^25.6.1",
68
+ "i18next-browser-languagedetector": "^8.2.0",
69
+ "jszip": "^3.10.1",
70
+ "lido-player": "^0.0.2-alpha-77",
71
+ "mathjs": "^14.4.0",
72
+ "tinycolor2": "^1.6.0"
73
+ }
74
+ }
package/readme.md CHANGED
@@ -1,114 +1,114 @@
1
- [![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)](https://stenciljs.com)
2
-
3
- # Stencil Component Starter
4
-
5
- This is a starter project for building a standalone Web Component using Stencil.
6
-
7
- Stencil is also great for building entire apps. For that, use the [stencil-app-starter](https://github.com/ionic-team/stencil-app-starter) instead.
8
-
9
- # Stencil
10
-
11
- Stencil is a compiler for building fast web apps using Web Components.
12
-
13
- Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than runtime tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.
14
-
15
- Stencil components are just Web Components, so they work in any major framework or with no framework at all.
16
-
17
- ## Getting Started
18
-
19
- To start building a new web component using Stencil, clone this repo to a new directory:
20
-
21
- ```bash
22
- git clone https://github.com/ionic-team/stencil-component-starter.git my-component
23
- cd my-component
24
- git remote rm origin
25
- ```
26
-
27
- and run:
28
-
29
- ```bash
30
- npm install
31
- npm start
32
- ```
33
-
34
- To build the component for production, run:
35
-
36
- ```bash
37
- npm run build
38
- ```
39
-
40
- To run the unit tests for the components, run:
41
-
42
- ```bash
43
- npm test
44
- ```
45
-
46
- Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).
47
-
48
- ## Naming Components
49
-
50
- When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: `<stencil-datepicker>`). This is because the generated component has little to nothing to do with Stencil; it's just a web component!
51
-
52
- Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic-generated web components use the prefix `ion`.
53
-
54
- ## Using this component
55
-
56
- There are two strategies we recommend for using web components built with Stencil.
57
-
58
- The first step for all two of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages).
59
-
60
- You can read more about these different approaches in the [Stencil docs](https://stenciljs.com/docs/publishing).
61
-
62
- ### Lazy Loading
63
-
64
- If your Stencil project is built with the [`dist`](https://stenciljs.com/docs/distribution) output target, you can import a small bootstrap script that registers all components and allows you to load individual component scripts lazily.
65
-
66
- For example, given your Stencil project namespace is called `my-design-system`, to use `my-component` on any website, inject this into your HTML:
67
-
68
- ```html
69
- <script type="module" src="https://unpkg.com/my-design-system"></script>
70
- <!--
71
- To avoid unpkg.com redirects to the actual file, you can also directly import:
72
- https://unpkg.com/foobar-design-system@0.0.1/dist/foobar-design-system/foobar-design-system.esm.js
73
- -->
74
- <my-component first="Stencil" last="'Don't call me a framework' JS"></my-component>
75
- ```
76
-
77
- This will only load the necessary scripts needed to render `<my-component />`. Once more components of this package are used, they will automatically be loaded lazily.
78
-
79
- You can also import the script as part of your `node_modules` in your applications entry file:
80
-
81
- ```tsx
82
- import 'foobar-design-system/dist/foobar-design-system/foobar-design-system.esm.js';
83
- ```
84
-
85
- Check out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-y6v26a?file=src%2Fmain.tsx).
86
-
87
- ### Standalone
88
-
89
- If you are using a Stencil component library with `dist-custom-elements`, we recommend importing Stencil components individually in those files where they are needed.
90
-
91
- To export Stencil components as standalone components make sure you have the [`dist-custom-elements`](https://stenciljs.com/docs/custom-elements) output target defined in your `stencil.config.ts`.
92
-
93
- For example, given you'd like to use `<my-component />` as part of a React component, you can import the component directly via:
94
-
95
- ```tsx
96
- import 'foobar-design-system/my-component';
97
-
98
- function App() {
99
- return (
100
- <>
101
- <div>
102
- <my-component
103
- first="Stencil"
104
- last="'Don't call me a framework' JS"
105
- ></my-component>
106
- </div>
107
- </>
108
- );
109
- }
110
-
111
- export default App;
112
- ```
113
-
1
+ [![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)](https://stenciljs.com)
2
+
3
+ # Stencil Component Starter
4
+
5
+ This is a starter project for building a standalone Web Component using Stencil.
6
+
7
+ Stencil is also great for building entire apps. For that, use the [stencil-app-starter](https://github.com/ionic-team/stencil-app-starter) instead.
8
+
9
+ # Stencil
10
+
11
+ Stencil is a compiler for building fast web apps using Web Components.
12
+
13
+ Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than runtime tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.
14
+
15
+ Stencil components are just Web Components, so they work in any major framework or with no framework at all.
16
+
17
+ ## Getting Started
18
+
19
+ To start building a new web component using Stencil, clone this repo to a new directory:
20
+
21
+ ```bash
22
+ git clone https://github.com/ionic-team/stencil-component-starter.git my-component
23
+ cd my-component
24
+ git remote rm origin
25
+ ```
26
+
27
+ and run:
28
+
29
+ ```bash
30
+ npm install
31
+ npm start
32
+ ```
33
+
34
+ To build the component for production, run:
35
+
36
+ ```bash
37
+ npm run build
38
+ ```
39
+
40
+ To run the unit tests for the components, run:
41
+
42
+ ```bash
43
+ npm test
44
+ ```
45
+
46
+ Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).
47
+
48
+ ## Naming Components
49
+
50
+ When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: `<stencil-datepicker>`). This is because the generated component has little to nothing to do with Stencil; it's just a web component!
51
+
52
+ Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic-generated web components use the prefix `ion`.
53
+
54
+ ## Using this component
55
+
56
+ There are two strategies we recommend for using web components built with Stencil.
57
+
58
+ The first step for all two of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages).
59
+
60
+ You can read more about these different approaches in the [Stencil docs](https://stenciljs.com/docs/publishing).
61
+
62
+ ### Lazy Loading
63
+
64
+ If your Stencil project is built with the [`dist`](https://stenciljs.com/docs/distribution) output target, you can import a small bootstrap script that registers all components and allows you to load individual component scripts lazily.
65
+
66
+ For example, given your Stencil project namespace is called `my-design-system`, to use `my-component` on any website, inject this into your HTML:
67
+
68
+ ```html
69
+ <script type="module" src="https://unpkg.com/my-design-system"></script>
70
+ <!--
71
+ To avoid unpkg.com redirects to the actual file, you can also directly import:
72
+ https://unpkg.com/foobar-design-system@0.0.1/dist/foobar-design-system/foobar-design-system.esm.js
73
+ -->
74
+ <my-component first="Stencil" last="'Don't call me a framework' JS"></my-component>
75
+ ```
76
+
77
+ This will only load the necessary scripts needed to render `<my-component />`. Once more components of this package are used, they will automatically be loaded lazily.
78
+
79
+ You can also import the script as part of your `node_modules` in your applications entry file:
80
+
81
+ ```tsx
82
+ import 'foobar-design-system/dist/foobar-design-system/foobar-design-system.esm.js';
83
+ ```
84
+
85
+ Check out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-y6v26a?file=src%2Fmain.tsx).
86
+
87
+ ### Standalone
88
+
89
+ If you are using a Stencil component library with `dist-custom-elements`, we recommend importing Stencil components individually in those files where they are needed.
90
+
91
+ To export Stencil components as standalone components make sure you have the [`dist-custom-elements`](https://stenciljs.com/docs/custom-elements) output target defined in your `stencil.config.ts`.
92
+
93
+ For example, given you'd like to use `<my-component />` as part of a React component, you can import the component directly via:
94
+
95
+ ```tsx
96
+ import 'foobar-design-system/my-component';
97
+
98
+ function App() {
99
+ return (
100
+ <>
101
+ <div>
102
+ <my-component
103
+ first="Stencil"
104
+ last="'Don't call me a framework' JS"
105
+ ></my-component>
106
+ </div>
107
+ </>
108
+ );
109
+ }
110
+
111
+ export default App;
112
+ ```
113
+
114
114
  Check out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-b6zuds?file=src%2FApp.tsx).