familiar-vue 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (324) hide show
  1. package/LICENSE +22 -0
  2. package/NOTICE +16 -0
  3. package/README.md +125 -2
  4. package/dist/ImageGeneration-Bzaxz69O.js +2383 -0
  5. package/dist/ImageGeneration-Bzaxz69O.js.map +1 -0
  6. package/dist/ImageGeneration-DaSEThTI.cjs +686 -0
  7. package/dist/ImageGeneration-DaSEThTI.cjs.map +1 -0
  8. package/dist/Liquid.vue_vue_type_script_setup_true_lang-CFv8ZG8G.js +1127 -0
  9. package/dist/Liquid.vue_vue_type_script_setup_true_lang-CFv8ZG8G.js.map +1 -0
  10. package/dist/Liquid.vue_vue_type_script_setup_true_lang-D4ii7clD.cjs +2 -0
  11. package/dist/Liquid.vue_vue_type_script_setup_true_lang-D4ii7clD.cjs.map +1 -0
  12. package/dist/LiquidItem.vue_vue_type_script_setup_true_lang-DJryRpk6.js +450 -0
  13. package/dist/LiquidItem.vue_vue_type_script_setup_true_lang-DJryRpk6.js.map +1 -0
  14. package/dist/LiquidItem.vue_vue_type_script_setup_true_lang-DapeZPmE.cjs +2 -0
  15. package/dist/LiquidItem.vue_vue_type_script_setup_true_lang-DapeZPmE.cjs.map +1 -0
  16. package/dist/MeltSurface.vue_vue_type_script_setup_true_lang-KrWVJyup.cjs +2 -0
  17. package/dist/MeltSurface.vue_vue_type_script_setup_true_lang-KrWVJyup.cjs.map +1 -0
  18. package/dist/MeltSurface.vue_vue_type_script_setup_true_lang-cFDLNQ6f.js +489 -0
  19. package/dist/MeltSurface.vue_vue_type_script_setup_true_lang-cFDLNQ6f.js.map +1 -0
  20. package/dist/blocks/bots/BotAvatar.vue.d.ts +52 -0
  21. package/dist/blocks/bots/BotList.vue.d.ts +41 -0
  22. package/dist/blocks/bots/engine/color.d.ts +20 -0
  23. package/dist/blocks/bots/engine/draw.d.ts +106 -0
  24. package/dist/blocks/bots/engine/engine.d.ts +170 -0
  25. package/dist/blocks/bots/engine/mesh.d.ts +142 -0
  26. package/dist/blocks/bots/engine/plastic.d.ts +266 -0
  27. package/dist/blocks/bots/engine/presets.d.ts +12 -0
  28. package/dist/blocks/bots/engine/shapes.d.ts +4 -0
  29. package/dist/blocks/bots/engine/ticker.d.ts +8 -0
  30. package/dist/blocks/bots/engine/types.d.ts +59 -0
  31. package/dist/blocks/bots/engine/wear.d.ts +58 -0
  32. package/dist/blocks/bots/index.d.ts +16 -0
  33. package/dist/blocks/bots/list-types.d.ts +50 -0
  34. package/dist/blocks/bots/styles.d.ts +1 -0
  35. package/dist/blocks/bots/types-1.d.ts +209 -0
  36. package/dist/blocks/bots/types.d.ts +214 -0
  37. package/dist/blocks/cards/CardDeck.vue.d.ts +24 -0
  38. package/dist/blocks/cards/CardFace.vue.d.ts +7 -0
  39. package/dist/blocks/cards/engine/motion.d.ts +35 -0
  40. package/dist/blocks/cards/engine/scenes.d.ts +18 -0
  41. package/dist/blocks/cards/index.d.ts +24 -0
  42. package/dist/blocks/cards/types.d.ts +52 -0
  43. package/dist/blocks/copy-field/CopyField.vue.d.ts +22 -0
  44. package/dist/blocks/copy-field/highlight.d.ts +2 -0
  45. package/dist/blocks/copy-field/icons.d.ts +9 -0
  46. package/dist/blocks/copy-field/index.d.ts +33 -0
  47. package/dist/blocks/copy-field/snippet.d.ts +9 -0
  48. package/dist/blocks/copy-field/styles.d.ts +1 -0
  49. package/dist/blocks/copy-field/types.d.ts +55 -0
  50. package/dist/blocks/gooey/ImageMeltItem.vue.d.ts +25 -0
  51. package/dist/blocks/gooey/ImageMeltLayer.vue.d.ts +3 -0
  52. package/dist/blocks/gooey/Liquid.vue.d.ts +23 -0
  53. package/dist/blocks/gooey/LiquidItem.vue.d.ts +26 -0
  54. package/dist/blocks/gooey/context.d.ts +19 -0
  55. package/dist/blocks/gooey/engine/filter.d.ts +20 -0
  56. package/dist/blocks/gooey/engine/geometry.d.ts +19 -0
  57. package/dist/blocks/gooey/engine/observer.d.ts +232 -0
  58. package/dist/blocks/gooey/engine/shadow.d.ts +13 -0
  59. package/dist/blocks/gooey/engine/spring.d.ts +22 -0
  60. package/dist/blocks/gooey/index.d.ts +136 -0
  61. package/dist/blocks/gooey/types.d.ts +152 -0
  62. package/dist/blocks/image/index.d.ts +24 -0
  63. package/dist/blocks/image/studio/ImageStudio.vue.d.ts +41 -0
  64. package/dist/blocks/image/studio/MeltStage.vue.d.ts +35 -0
  65. package/dist/blocks/image/studio/generation/ImageGeneration.vue.d.ts +31 -0
  66. package/dist/blocks/image/studio/generation/engine/cycle.d.ts +101 -0
  67. package/dist/blocks/image/studio/generation/engine/index.d.ts +8 -0
  68. package/dist/blocks/image/studio/generation/engine/palette.d.ts +15 -0
  69. package/dist/blocks/image/studio/generation/engine/renderer.d.ts +248 -0
  70. package/dist/blocks/image/studio/generation/engine/reveal.d.ts +60 -0
  71. package/dist/blocks/image/studio/generation/engine/shaders.d.ts +24 -0
  72. package/dist/blocks/image/studio/generation/engine/tween.d.ts +8 -0
  73. package/dist/blocks/image/studio/generation/presets/index.d.ts +158 -0
  74. package/dist/blocks/image/studio/generation/presets/pixels-mechanic.d.ts +6 -0
  75. package/dist/blocks/image/studio/generation/presets/pixels-organic.d.ts +6 -0
  76. package/dist/blocks/image/studio/generation/presets/sweep-gradient.d.ts +2 -0
  77. package/dist/blocks/image/studio/generation/styles.d.ts +3 -0
  78. package/dist/blocks/image/studio/generation/types.d.ts +192 -0
  79. package/dist/blocks/image/studio/studio-styles.d.ts +3 -0
  80. package/dist/blocks/image/studio/studio-types.d.ts +119 -0
  81. package/dist/blocks/inputs/InputField.vue.d.ts +65 -0
  82. package/dist/blocks/inputs/icons.d.ts +21 -0
  83. package/dist/blocks/inputs/index.d.ts +69 -0
  84. package/dist/blocks/inputs/styles.d.ts +1 -0
  85. package/dist/blocks/inputs/types.d.ts +133 -0
  86. package/dist/blocks/loading/CloudLoading.vue.d.ts +44 -0
  87. package/dist/blocks/loading/Loading.vue.d.ts +8 -0
  88. package/dist/blocks/loading/engine.d.ts +46 -0
  89. package/dist/blocks/loading/index.d.ts +117 -0
  90. package/dist/blocks/loading/types.d.ts +64 -0
  91. package/dist/blocks/message-actions/MessageActions.vue.d.ts +134 -0
  92. package/dist/blocks/message-actions/ReactionGlyph.vue.d.ts +7 -0
  93. package/dist/blocks/message-actions/icons.d.ts +14 -0
  94. package/dist/blocks/message-actions/index.d.ts +109 -0
  95. package/dist/blocks/message-actions/sets.d.ts +4 -0
  96. package/dist/blocks/message-actions/styles.d.ts +1 -0
  97. package/dist/blocks/message-actions/types.d.ts +107 -0
  98. package/dist/blocks/metal/MetalBadge.vue.d.ts +42 -0
  99. package/dist/blocks/metal/MetalFx.vue.d.ts +67 -0
  100. package/dist/blocks/metal/MetalText.vue.d.ts +44 -0
  101. package/dist/blocks/metal/bridge.d.ts +24 -0
  102. package/dist/blocks/metal/defaults.d.ts +22 -0
  103. package/dist/blocks/metal/engine/bend/config.d.ts +80 -0
  104. package/dist/blocks/metal/engine/color.d.ts +13 -0
  105. package/dist/blocks/metal/engine/cursor/light.d.ts +78 -0
  106. package/dist/blocks/metal/engine/glow/bake.d.ts +27 -0
  107. package/dist/blocks/metal/engine/glow/config.d.ts +88 -0
  108. package/dist/blocks/metal/engine/glow/geometry.d.ts +48 -0
  109. package/dist/blocks/metal/engine/glow/glow.d.ts +133 -0
  110. package/dist/blocks/metal/engine/perfConfig.d.ts +9 -0
  111. package/dist/blocks/metal/engine/presets.d.ts +86 -0
  112. package/dist/blocks/metal/engine/reflection/constants.d.ts +48 -0
  113. package/dist/blocks/metal/engine/reflection/geometry.d.ts +30 -0
  114. package/dist/blocks/metal/engine/reflection/observers.d.ts +28 -0
  115. package/dist/blocks/metal/engine/reflection/paint.d.ts +29 -0
  116. package/dist/blocks/metal/engine/reflection/reflectionScheduler.d.ts +1 -0
  117. package/dist/blocks/metal/engine/renderer/core.d.ts +157 -0
  118. package/dist/blocks/metal/engine/renderer/loop.d.ts +60 -0
  119. package/dist/blocks/metal/engine/renderer/outline.d.ts +22 -0
  120. package/dist/blocks/metal/engine/renderer/sampling.d.ts +16 -0
  121. package/dist/blocks/metal/engine/rim.d.ts +52 -0
  122. package/dist/blocks/metal/engine/shaders.d.ts +8 -0
  123. package/dist/blocks/metal/engine/textMask.d.ts +11 -0
  124. package/dist/blocks/metal/engine/tween.d.ts +17 -0
  125. package/dist/blocks/metal/index.d.ts +20 -0
  126. package/dist/blocks/metal/styles.d.ts +1 -0
  127. package/dist/blocks/metal/types.d.ts +155 -0
  128. package/dist/blocks/navigation/NavigationBar.vue.d.ts +39 -0
  129. package/dist/blocks/navigation/defaults.d.ts +3 -0
  130. package/dist/blocks/navigation/icons.d.ts +7 -0
  131. package/dist/blocks/navigation/index.d.ts +77 -0
  132. package/dist/blocks/navigation/styles.d.ts +1 -0
  133. package/dist/blocks/navigation/types.d.ts +62 -0
  134. package/dist/blocks/orbs/ThinkingOrb.vue.d.ts +12 -0
  135. package/dist/blocks/orbs/engine/braid.d.ts +2 -0
  136. package/dist/blocks/orbs/engine/core.d.ts +75 -0
  137. package/dist/blocks/orbs/engine/index.d.ts +6 -0
  138. package/dist/blocks/orbs/engine/lattice.d.ts +4 -0
  139. package/dist/blocks/orbs/engine/morph.d.ts +2 -0
  140. package/dist/blocks/orbs/engine/orbits.d.ts +2 -0
  141. package/dist/blocks/orbs/engine/profiles.d.ts +18 -0
  142. package/dist/blocks/orbs/engine/registry.d.ts +10 -0
  143. package/dist/blocks/orbs/engine/ribbon.d.ts +2 -0
  144. package/dist/blocks/orbs/engine/types.d.ts +14 -0
  145. package/dist/blocks/orbs/engine/web.d.ts +2 -0
  146. package/dist/blocks/orbs/gravity.d.ts +102 -0
  147. package/dist/blocks/orbs/index.d.ts +10 -0
  148. package/dist/blocks/orbs/presets.d.ts +20 -0
  149. package/dist/blocks/orbs/theme.d.ts +6 -0
  150. package/dist/blocks/orbs/types.d.ts +122 -0
  151. package/dist/blocks/panels/ResizablePanels.vue.d.ts +28 -0
  152. package/dist/blocks/panels/index.d.ts +49 -0
  153. package/dist/blocks/panels/styles.d.ts +1 -0
  154. package/dist/blocks/panels/types.d.ts +43 -0
  155. package/dist/blocks/sliders/Slider.vue.d.ts +24 -0
  156. package/dist/blocks/sliders/index.d.ts +25 -0
  157. package/dist/blocks/sliders/styles.d.ts +1 -0
  158. package/dist/blocks/sliders/types.d.ts +96 -0
  159. package/dist/blocks/text-stream/TextStream.vue.d.ts +29 -0
  160. package/dist/blocks/text-stream/engine.d.ts +31 -0
  161. package/dist/blocks/text-stream/index.d.ts +36 -0
  162. package/dist/blocks/text-stream/types.d.ts +70 -0
  163. package/dist/blocks/theme-reveal/ThemeReveal.vue.d.ts +48 -0
  164. package/dist/blocks/theme-reveal/engine.d.ts +72 -0
  165. package/dist/blocks/theme-reveal/index.d.ts +100 -0
  166. package/dist/blocks/theme-reveal/types.d.ts +64 -0
  167. package/dist/blocks/toast-stack/ToastStack.vue.d.ts +20 -0
  168. package/dist/blocks/toast-stack/defaults.d.ts +10 -0
  169. package/dist/blocks/toast-stack/icons.d.ts +13 -0
  170. package/dist/blocks/toast-stack/index.d.ts +18 -0
  171. package/dist/blocks/toast-stack/styles.d.ts +1 -0
  172. package/dist/blocks/toast-stack/types.d.ts +79 -0
  173. package/dist/bots.cjs +2 -0
  174. package/dist/bots.cjs.map +1 -0
  175. package/dist/bots.d.ts +2 -0
  176. package/dist/bots.js +35 -0
  177. package/dist/bots.js.map +1 -0
  178. package/dist/cards.cjs +2 -0
  179. package/dist/cards.cjs.map +1 -0
  180. package/dist/cards.d.ts +1 -0
  181. package/dist/cards.js +6 -0
  182. package/dist/cards.js.map +1 -0
  183. package/dist/copy-field.cjs +2 -0
  184. package/dist/copy-field.cjs.map +1 -0
  185. package/dist/copy-field.d.ts +1 -0
  186. package/dist/copy-field.js +9 -0
  187. package/dist/copy-field.js.map +1 -0
  188. package/dist/familiar-vue.css +1 -0
  189. package/dist/gooey.cjs +2 -0
  190. package/dist/gooey.cjs.map +1 -0
  191. package/dist/gooey.d.ts +1 -0
  192. package/dist/gooey.js +14 -0
  193. package/dist/gooey.js.map +1 -0
  194. package/dist/image.cjs +2 -0
  195. package/dist/image.cjs.map +1 -0
  196. package/dist/image.d.ts +1 -0
  197. package/dist/image.js +6 -0
  198. package/dist/image.js.map +1 -0
  199. package/dist/images/aurora.svg +67 -0
  200. package/dist/images/ember.svg +67 -0
  201. package/dist/images/tide.svg +71 -0
  202. package/dist/index-B5TCPGEM.js +1100 -0
  203. package/dist/index-B5TCPGEM.js.map +1 -0
  204. package/dist/index-B5nIfIEp.js +1279 -0
  205. package/dist/index-B5nIfIEp.js.map +1 -0
  206. package/dist/index-BAZi5af3.cjs +221 -0
  207. package/dist/index-BAZi5af3.cjs.map +1 -0
  208. package/dist/index-BJCkUW5A.js +3032 -0
  209. package/dist/index-BJCkUW5A.js.map +1 -0
  210. package/dist/index-BMZE9a3d.cjs +2 -0
  211. package/dist/index-BMZE9a3d.cjs.map +1 -0
  212. package/dist/index-BNtY2Npf.cjs +295 -0
  213. package/dist/index-BNtY2Npf.cjs.map +1 -0
  214. package/dist/index-B_0tDvWP.cjs +2 -0
  215. package/dist/index-B_0tDvWP.cjs.map +1 -0
  216. package/dist/index-BbVBtT5j.js +316 -0
  217. package/dist/index-BbVBtT5j.js.map +1 -0
  218. package/dist/index-BlzIHBF1.js +515 -0
  219. package/dist/index-BlzIHBF1.js.map +1 -0
  220. package/dist/index-BmMsid7x.js +422 -0
  221. package/dist/index-BmMsid7x.js.map +1 -0
  222. package/dist/index-BpjDl2gX.cjs +111 -0
  223. package/dist/index-BpjDl2gX.cjs.map +1 -0
  224. package/dist/index-CI5z5qOi.cjs +3 -0
  225. package/dist/index-CI5z5qOi.cjs.map +1 -0
  226. package/dist/index-COEbtI5G.js +540 -0
  227. package/dist/index-COEbtI5G.js.map +1 -0
  228. package/dist/index-CQIOTNIw.js +4440 -0
  229. package/dist/index-CQIOTNIw.js.map +1 -0
  230. package/dist/index-CZs5zd59.js +588 -0
  231. package/dist/index-CZs5zd59.js.map +1 -0
  232. package/dist/index-Cmy6isLZ.js +541 -0
  233. package/dist/index-Cmy6isLZ.js.map +1 -0
  234. package/dist/index-CrxVR7ex.cjs +379 -0
  235. package/dist/index-CrxVR7ex.cjs.map +1 -0
  236. package/dist/index-CyHcjHb9.cjs +181 -0
  237. package/dist/index-CyHcjHb9.cjs.map +1 -0
  238. package/dist/index-DRLlT2zP.cjs +226 -0
  239. package/dist/index-DRLlT2zP.cjs.map +1 -0
  240. package/dist/index-DSk4XZD6.js +19 -0
  241. package/dist/index-DSk4XZD6.js.map +1 -0
  242. package/dist/index-DXUcLSTg.js +1025 -0
  243. package/dist/index-DXUcLSTg.js.map +1 -0
  244. package/dist/index-DZJ-MNwi.cjs +80 -0
  245. package/dist/index-DZJ-MNwi.cjs.map +1 -0
  246. package/dist/index-DqPJto2M.js +796 -0
  247. package/dist/index-DqPJto2M.js.map +1 -0
  248. package/dist/index-Dsh3Q6Rn.js +157 -0
  249. package/dist/index-Dsh3Q6Rn.js.map +1 -0
  250. package/dist/index-DvOUPBYU.cjs +1262 -0
  251. package/dist/index-DvOUPBYU.cjs.map +1 -0
  252. package/dist/index-Q6jqgFv1.cjs +2 -0
  253. package/dist/index-Q6jqgFv1.cjs.map +1 -0
  254. package/dist/index-T82yXcXP.cjs +117 -0
  255. package/dist/index-T82yXcXP.cjs.map +1 -0
  256. package/dist/index-dVhgGs3a.js +3040 -0
  257. package/dist/index-dVhgGs3a.js.map +1 -0
  258. package/dist/index-qWb4NhFs.cjs +510 -0
  259. package/dist/index-qWb4NhFs.cjs.map +1 -0
  260. package/dist/index-v4zOoCAt.cjs +369 -0
  261. package/dist/index-v4zOoCAt.cjs.map +1 -0
  262. package/dist/index.cjs +2 -0
  263. package/dist/index.cjs.map +1 -0
  264. package/dist/index.d.ts +54 -0
  265. package/dist/index.js +55 -0
  266. package/dist/index.js.map +1 -0
  267. package/dist/inputs.cjs +2 -0
  268. package/dist/inputs.cjs.map +1 -0
  269. package/dist/inputs.d.ts +1 -0
  270. package/dist/inputs.js +6 -0
  271. package/dist/inputs.js.map +1 -0
  272. package/dist/internal/melt/MeltSurface.vue.d.ts +17 -0
  273. package/dist/internal/melt/engine.d.ts +76 -0
  274. package/dist/loading.cjs +2 -0
  275. package/dist/loading.cjs.map +1 -0
  276. package/dist/loading.d.ts +1 -0
  277. package/dist/loading.js +6 -0
  278. package/dist/loading.js.map +1 -0
  279. package/dist/message-actions.cjs +2 -0
  280. package/dist/message-actions.cjs.map +1 -0
  281. package/dist/message-actions.d.ts +1 -0
  282. package/dist/message-actions.js +6 -0
  283. package/dist/message-actions.js.map +1 -0
  284. package/dist/metal.cjs +2 -0
  285. package/dist/metal.cjs.map +1 -0
  286. package/dist/metal.d.ts +1 -0
  287. package/dist/metal.js +54 -0
  288. package/dist/metal.js.map +1 -0
  289. package/dist/navigation.cjs +2 -0
  290. package/dist/navigation.cjs.map +1 -0
  291. package/dist/navigation.d.ts +1 -0
  292. package/dist/navigation.js +6 -0
  293. package/dist/navigation.js.map +1 -0
  294. package/dist/orbs.cjs +2 -0
  295. package/dist/orbs.cjs.map +1 -0
  296. package/dist/orbs.d.ts +1 -0
  297. package/dist/orbs.js +28 -0
  298. package/dist/orbs.js.map +1 -0
  299. package/dist/panels.cjs +2 -0
  300. package/dist/panels.cjs.map +1 -0
  301. package/dist/panels.d.ts +1 -0
  302. package/dist/panels.js +6 -0
  303. package/dist/panels.js.map +1 -0
  304. package/dist/sliders.cjs +2 -0
  305. package/dist/sliders.cjs.map +1 -0
  306. package/dist/sliders.d.ts +1 -0
  307. package/dist/sliders.js +6 -0
  308. package/dist/sliders.js.map +1 -0
  309. package/dist/text-stream.cjs +5 -0
  310. package/dist/text-stream.cjs.map +1 -0
  311. package/dist/text-stream.d.ts +1 -0
  312. package/dist/text-stream.js +185 -0
  313. package/dist/text-stream.js.map +1 -0
  314. package/dist/theme-reveal.cjs +2 -0
  315. package/dist/theme-reveal.cjs.map +1 -0
  316. package/dist/theme-reveal.d.ts +1 -0
  317. package/dist/theme-reveal.js +7 -0
  318. package/dist/theme-reveal.js.map +1 -0
  319. package/dist/toast-stack.cjs +2 -0
  320. package/dist/toast-stack.cjs.map +1 -0
  321. package/dist/toast-stack.d.ts +1 -0
  322. package/dist/toast-stack.js +7 -0
  323. package/dist/toast-stack.js.map +1 -0
  324. package/package.json +138 -4
package/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Familiar Vue contributors
4
+ Portions copyright (c) Jakub Antalik
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be included in all
14
+ copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ SOFTWARE.
package/NOTICE ADDED
@@ -0,0 +1,16 @@
1
+ Familiar Vue
2
+ ============
3
+
4
+ This package contains Vue 3 ports of components from Libraries.dev by Jakub Antalik:
5
+
6
+ - bot-avatars — MIT
7
+ - liquid-gooey — MIT
8
+ - img-fx — MIT
9
+ - metal-fx — MIT
10
+ - thinking-orbs — MIT
11
+
12
+ Upstream project: https://github.com
13
+
14
+ The MetalFx shader imports `liquidMetalFragmentShader` from
15
+ `@paper-design/shaders`, which is licensed under Apache-2.0 by Paper Design.
16
+ Its license and notices remain with that dependency.
package/README.md CHANGED
@@ -1,3 +1,126 @@
1
- # Temporary Holding Version
1
+ # familiar-vue
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Vue 3 ports of expressive canvas, SVG and WebGL interface components. Each family is available from its own subpath so consumers only pull the engines they use.
4
+
5
+ ```bash
6
+ npm install familiar-vue
7
+ ```
8
+
9
+ ```ts
10
+ import { BotAvatar, BotList } from 'familiar-vue/bots'
11
+ import { ThinkingOrb } from 'familiar-vue/orbs'
12
+ ```
13
+
14
+ Only two families need an extra runtime package. Install it when you import them:
15
+
16
+ ```bash
17
+ npm install three # familiar-vue/image
18
+ npm install @paper-design/shaders # familiar-vue/metal
19
+ ```
20
+
21
+ The `cards`, `text-stream` and `loading` families ship their styles as a stylesheet; import it once in your app entry. The other families inject their own styles at runtime.
22
+
23
+ ```ts
24
+ import 'familiar-vue/style.css'
25
+ ```
26
+
27
+ ```vue
28
+ <script setup lang="ts">
29
+ import { BotAvatar } from 'familiar-vue/bots'
30
+ </script>
31
+
32
+ <template>
33
+ <BotAvatar type="clover" state="working" :size="64" />
34
+ </template>
35
+ ```
36
+
37
+ ## Available subpaths
38
+
39
+ | Subpath | Components |
40
+ | --- | --- |
41
+ | `familiar-vue/bots` | `BotAvatar`, `BotList` |
42
+ | `familiar-vue/cards` | `CardDeck` |
43
+ | `familiar-vue/gooey` | `Liquid`, `LiquidItem` |
44
+ | `familiar-vue/image` | `ImageStudio` |
45
+ | `familiar-vue/inputs` | `InputField` |
46
+ | `familiar-vue/message-actions` | `MessageActions` |
47
+ | `familiar-vue/metal` | `MetalFx`, `MetalText`, `MetalBadge` |
48
+ | `familiar-vue/navigation` | `NavigationBar` |
49
+ | `familiar-vue/orbs` | `ThinkingOrb` |
50
+ | `familiar-vue/panels` | `ResizablePanels` |
51
+ | `familiar-vue/sliders` | `ExpressiveSlider` |
52
+ | `familiar-vue/theme-reveal` | `ThemeReveal` |
53
+ | `familiar-vue/toast-stack` | `ToastStack` |
54
+
55
+ ```vue
56
+ <script setup lang="ts">
57
+ import { NavigationBar } from 'familiar-vue/navigation'
58
+ </script>
59
+
60
+ <template>
61
+ <NavigationBar mode="dock" :magnify="1.35" :spread="2" />
62
+ </template>
63
+ ```
64
+
65
+ `NavigationBar` combines four navigation behaviours behind one `mode` prop: `stretch` (icon bar), `jelly` (jelly tabs), `expand` (tab bar) and `dock` (magnifying dock). Use `items` for the tabs, `v-model` for controlled selection, and the `icon` slot for custom glyphs.
66
+
67
+ ```vue
68
+ <script setup lang="ts">
69
+ import { BotList } from 'familiar-vue/bots'
70
+ import { ResizablePanels } from 'familiar-vue/panels'
71
+ </script>
72
+
73
+ <template>
74
+ <ResizablePanels panels="3" :min-sidebar-width="88">
75
+ <template #sidebar="{ width }">
76
+ <BotList :items="assistants" surface="plain" :compact-at="170" />
77
+ </template>
78
+ <template #content>
79
+ <Conversation />
80
+ </template>
81
+ <template #details="{ width }">
82
+ <ConversationSettings :width="width" />
83
+ </template>
84
+ </ResizablePanels>
85
+ </template>
86
+ ```
87
+
88
+ `ResizablePanels` splits two or three panes on one slab. Give a pane a named slot (`sidebar`, `content`, `details`) and it receives its live `width` and `index`; without one it shows the library's skeleton. Use `minSidebarWidth` for a hard floor, `palette` for colours, and `@change` for the committed split. The exposed handle can `reset()` the natural widths, read `getWidths()`, or `setPaneWidth(index, width)` to fold a pane away and bring it back from a header button.
89
+
90
+ ```vue
91
+ <script setup lang="ts">
92
+ import { ToastStack } from 'familiar-vue/toast-stack'
93
+ </script>
94
+
95
+ <template>
96
+ <ToastStack :peek="14" :gap="10" :corner="20" />
97
+ </template>
98
+ ```
99
+
100
+ `ToastStack` keeps three notifications gathered at an edge: the newest in front, the two before it peeking out above it. Pointing at the stack fans it into a list on one spring, and dismissing a toast slides it away while the next one rises in at the front. Pass `toasts` for the starting three, `pool` for the replacements, `palette` for colours, and listen to `@dismiss` and `@action`; an item's `resolve` describes what an action turns it into in place.
101
+
102
+ ```vue
103
+ <script setup lang="ts">
104
+ import { ThemeReveal } from 'familiar-vue/theme-reveal'
105
+ </script>
106
+
107
+ <template>
108
+ <ThemeReveal v-model:theme="theme" :duration="480" origin="pointer">
109
+ <template #default="{ theme, toggle }">
110
+ <section class="panel" @click="toggle($event)">
111
+ <button type="button" @click.stop="toggle($event)">
112
+ {{ theme === 'dark' ? 'Light mode' : 'Dark mode' }}
113
+ </button>
114
+ </section>
115
+ </template>
116
+ </ThemeReveal>
117
+ </template>
118
+ ```
119
+
120
+ `ThemeReveal` swaps a surface's palette inside a circle clipped to the surface's own snapshot, so the page around it never repaints. `origin` picks the pointer, centre or a corner; `direction` grows the incoming theme in or pulls the outgoing one out; `duration` and `easing` shape the circle. Bind `v-model:theme` to the current theme and write your palettes with `[data-theme]`; with reduced motion or no View Transitions, the swap is instant.
121
+
122
+ `vue` is a required peer dependency. `three` and `@paper-design/shaders` are optional peers: install them only if you import the image or metal family. The bots, cards, gooey, inputs, message-actions, navigation, orbs, panels, sliders, theme-reveal and toast-stack families have no runtime dependency beyond Vue.
123
+
124
+ ## License and attribution
125
+
126
+ MIT for the Vue ports and upstream MIT engines. See [LICENSE](./LICENSE) and [NOTICE](./NOTICE). The Liquid Metal family uses an Apache-2.0 shader from `@paper-design/shaders`.