@useclickly/react 1.0.4 → 1.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 (52) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +7 -2
  3. package/dist/index.cjs +5237 -1455
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.d.cts +31 -7
  6. package/dist/index.d.ts +93 -12
  7. package/dist/index.js +5181 -1390
  8. package/dist/index.js.map +1 -1
  9. package/package.json +13 -12
  10. package/dist/Clickly.d.ts +0 -25
  11. package/dist/Clickly.d.ts.map +0 -1
  12. package/dist/hooks/useDraggable.d.ts +0 -28
  13. package/dist/hooks/useDraggable.d.ts.map +0 -1
  14. package/dist/hooks/usePersistedState.d.ts +0 -6
  15. package/dist/hooks/usePersistedState.d.ts.map +0 -1
  16. package/dist/index.d.ts.map +0 -1
  17. package/dist/internal/AnnotationList.d.ts +0 -11
  18. package/dist/internal/AnnotationList.d.ts.map +0 -1
  19. package/dist/internal/AnnotationPins.d.ts +0 -2
  20. package/dist/internal/AnnotationPins.d.ts.map +0 -1
  21. package/dist/internal/AnnotationPopup.d.ts +0 -5
  22. package/dist/internal/AnnotationPopup.d.ts.map +0 -1
  23. package/dist/internal/ClicklyRoot.d.ts +0 -15
  24. package/dist/internal/ClicklyRoot.d.ts.map +0 -1
  25. package/dist/internal/CollapsedFAB.d.ts +0 -10
  26. package/dist/internal/CollapsedFAB.d.ts.map +0 -1
  27. package/dist/internal/SettingsPopover.d.ts +0 -11
  28. package/dist/internal/SettingsPopover.d.ts.map +0 -1
  29. package/dist/internal/Toolbar.d.ts +0 -8
  30. package/dist/internal/Toolbar.d.ts.map +0 -1
  31. package/dist/internal/globalStyles.d.ts +0 -13
  32. package/dist/internal/globalStyles.d.ts.map +0 -1
  33. package/dist/internal/icons.d.ts +0 -14
  34. package/dist/internal/icons.d.ts.map +0 -1
  35. package/dist/internal/styles.d.ts +0 -7
  36. package/dist/internal/styles.d.ts.map +0 -1
  37. package/dist/output/markdown.d.ts +0 -5
  38. package/dist/output/markdown.d.ts.map +0 -1
  39. package/dist/output/markdown.test.d.ts +0 -2
  40. package/dist/output/markdown.test.d.ts.map +0 -1
  41. package/dist/state/annotations.d.ts +0 -21
  42. package/dist/state/annotations.d.ts.map +0 -1
  43. package/dist/state/annotations.test.d.ts +0 -2
  44. package/dist/state/annotations.test.d.ts.map +0 -1
  45. package/dist/state/settings.d.ts +0 -14
  46. package/dist/state/settings.d.ts.map +0 -1
  47. package/dist/state/settings.test.d.ts +0 -2
  48. package/dist/state/settings.test.d.ts.map +0 -1
  49. package/dist/state/useEngineState.d.ts +0 -7
  50. package/dist/state/useEngineState.d.ts.map +0 -1
  51. package/dist/test/setup.d.ts +0 -7
  52. package/dist/test/setup.d.ts.map +0 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Clickly contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -40,6 +40,9 @@ That's it. The component returns `null` on the server (safe under SSR / Next App
40
40
  | **Single** | Click any element → popup with comment box |
41
41
  | **Multi-select** | Press `2` or shift-click to pin elements, hit **Annotate (N)** when done |
42
42
  | **Area drag** | Press `3`, drag a rectangle, every intersecting element gets pinned |
43
+ | **Draw** | Press `4` to sketch freehand strokes — saved as AFS stroke annotations |
44
+ | **Layout mode** | Press `L` for a component palette + section-rearrange overlay. Optional wireframe sub-mode fades the page so you can sketch a fresh layout. |
45
+ | **Animation pause** | Press `P` to freeze CSS / WAAPI / GSAP / videos for annotating a specific frame |
43
46
  | **Persistent pins** | Annotated elements stay numbered on the page across page interactions |
44
47
  | **Auto-copy** | Submitting an annotation copies markdown to clipboard (toggleable) |
45
48
  | **Settings** | Output detail tier, React component info, marker colour — all in the gear menu |
@@ -61,9 +64,11 @@ For every selected element, Clickly automatically collects:
61
64
  | Key | Action |
62
65
  |---|---|
63
66
  | `⌘/Ctrl + Shift + F` | Toggle the toolbar |
64
- | `1` / `2` / `3` | Switch mode (single / multi / area) |
67
+ | `1` / `2` / `3` / `4` | Switch mode (single / multi / area / draw) |
68
+ | `L` | Toggle layout mode (palette + section rearrange) |
69
+ | `P` | Pause / resume page animations |
65
70
  | `Enter` | Open the popup with all pinned elements |
66
- | `Esc` | Cancel popup · or clear pins · or collapse toolbar |
71
+ | `Esc` | Cancel popup · cancel a layout drag · clear pins · or collapse toolbar |
67
72
  | `C` | Copy all annotations as markdown |
68
73
  | `X` | Clear all annotations |
69
74