@veltdev/react 1.0.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 (100) hide show
  1. package/cjs/index.js +381 -0
  2. package/cjs/index.js.map +1 -0
  3. package/cjs/types/components/Snippyly/Snippyly.d.ts +11 -0
  4. package/cjs/types/components/Snippyly/Snippyly.stories.d.ts +5 -0
  5. package/cjs/types/components/Snippyly/index.d.ts +1 -0
  6. package/cjs/types/components/SnippylyArrowTool/SnippylyArrowTool.d.ts +3 -0
  7. package/cjs/types/components/SnippylyArrowTool/index.d.ts +1 -0
  8. package/cjs/types/components/SnippylyArrows/SnippylyArrows.d.ts +3 -0
  9. package/cjs/types/components/SnippylyArrows/index.d.ts +1 -0
  10. package/cjs/types/components/SnippylyCommentBubble/SnippylyCommentBubble.d.ts +12 -0
  11. package/cjs/types/components/SnippylyCommentBubble/index.d.ts +1 -0
  12. package/cjs/types/components/SnippylyCommentTool/SnippylyCommentTool.d.ts +6 -0
  13. package/cjs/types/components/SnippylyCommentTool/index.d.ts +1 -0
  14. package/cjs/types/components/SnippylyComments/SnippylyComments.d.ts +134 -0
  15. package/cjs/types/components/SnippylyComments/index.d.ts +1 -0
  16. package/cjs/types/components/SnippylyCommentsSidebar/SnippylyCommentsSidebar.d.ts +17 -0
  17. package/cjs/types/components/SnippylyCommentsSidebar/index.d.ts +1 -0
  18. package/cjs/types/components/SnippylyCursor/SnippylyCursor.d.ts +13 -0
  19. package/cjs/types/components/SnippylyCursor/index.d.ts +1 -0
  20. package/cjs/types/components/SnippylyHuddle/SnippylyHuddle.d.ts +5 -0
  21. package/cjs/types/components/SnippylyHuddle/index.d.ts +1 -0
  22. package/cjs/types/components/SnippylyHuddleTool/SnippylyHuddleTool.d.ts +6 -0
  23. package/cjs/types/components/SnippylyHuddleTool/index.d.ts +1 -0
  24. package/cjs/types/components/SnippylyPresence/SnippylyPresence.d.ts +25 -0
  25. package/cjs/types/components/SnippylyPresence/index.d.ts +1 -0
  26. package/cjs/types/components/SnippylyRecorderControlPanel/SnippylyRecorderControlPanel.d.ts +8 -0
  27. package/cjs/types/components/SnippylyRecorderControlPanel/index.d.ts +1 -0
  28. package/cjs/types/components/SnippylyRecorderNotes/SnippylyRecorderNotes.d.ts +5 -0
  29. package/cjs/types/components/SnippylyRecorderNotes/index.d.ts +1 -0
  30. package/cjs/types/components/SnippylyRecorderPlayer/SnippylyRecorderPlayer.d.ts +12 -0
  31. package/cjs/types/components/SnippylyRecorderPlayer/index.d.ts +1 -0
  32. package/cjs/types/components/SnippylyRecorderTool/SnippylyRecorderTool.d.ts +8 -0
  33. package/cjs/types/components/SnippylyRecorderTool/index.d.ts +1 -0
  34. package/cjs/types/components/SnippylySidebarButton/SnippylySidebarButton.d.ts +6 -0
  35. package/cjs/types/components/SnippylySidebarButton/index.d.ts +1 -0
  36. package/cjs/types/components/SnippylyTagTool/SnippylyTagTool.d.ts +6 -0
  37. package/cjs/types/components/SnippylyTagTool/index.d.ts +1 -0
  38. package/cjs/types/components/SnippylyTags/SnippylyTags.d.ts +6 -0
  39. package/cjs/types/components/SnippylyTags/index.d.ts +1 -0
  40. package/cjs/types/components/SnippylyUserInviteTool/SnippylyUserInviteTool.d.ts +10 -0
  41. package/cjs/types/components/SnippylyUserInviteTool/index.d.ts +1 -0
  42. package/cjs/types/components/SnippylyUserRequestTool/SnippylyUserRequestTool.d.ts +11 -0
  43. package/cjs/types/components/SnippylyUserRequestTool/index.d.ts +1 -0
  44. package/cjs/types/components/index.d.ts +20 -0
  45. package/cjs/types/constants.d.ts +1 -0
  46. package/cjs/types/context/SnippylyContext.d.ts +8 -0
  47. package/cjs/types/context/index.d.ts +1 -0
  48. package/cjs/types/index.d.ts +3 -0
  49. package/cjs/types/loadSnippyly.d.ts +2 -0
  50. package/esm/index.js +353 -0
  51. package/esm/index.js.map +1 -0
  52. package/esm/types/components/Snippyly/Snippyly.d.ts +11 -0
  53. package/esm/types/components/Snippyly/Snippyly.stories.d.ts +5 -0
  54. package/esm/types/components/Snippyly/index.d.ts +1 -0
  55. package/esm/types/components/SnippylyArrowTool/SnippylyArrowTool.d.ts +3 -0
  56. package/esm/types/components/SnippylyArrowTool/index.d.ts +1 -0
  57. package/esm/types/components/SnippylyArrows/SnippylyArrows.d.ts +3 -0
  58. package/esm/types/components/SnippylyArrows/index.d.ts +1 -0
  59. package/esm/types/components/SnippylyCommentBubble/SnippylyCommentBubble.d.ts +12 -0
  60. package/esm/types/components/SnippylyCommentBubble/index.d.ts +1 -0
  61. package/esm/types/components/SnippylyCommentTool/SnippylyCommentTool.d.ts +6 -0
  62. package/esm/types/components/SnippylyCommentTool/index.d.ts +1 -0
  63. package/esm/types/components/SnippylyComments/SnippylyComments.d.ts +134 -0
  64. package/esm/types/components/SnippylyComments/index.d.ts +1 -0
  65. package/esm/types/components/SnippylyCommentsSidebar/SnippylyCommentsSidebar.d.ts +17 -0
  66. package/esm/types/components/SnippylyCommentsSidebar/index.d.ts +1 -0
  67. package/esm/types/components/SnippylyCursor/SnippylyCursor.d.ts +13 -0
  68. package/esm/types/components/SnippylyCursor/index.d.ts +1 -0
  69. package/esm/types/components/SnippylyHuddle/SnippylyHuddle.d.ts +5 -0
  70. package/esm/types/components/SnippylyHuddle/index.d.ts +1 -0
  71. package/esm/types/components/SnippylyHuddleTool/SnippylyHuddleTool.d.ts +6 -0
  72. package/esm/types/components/SnippylyHuddleTool/index.d.ts +1 -0
  73. package/esm/types/components/SnippylyPresence/SnippylyPresence.d.ts +25 -0
  74. package/esm/types/components/SnippylyPresence/index.d.ts +1 -0
  75. package/esm/types/components/SnippylyRecorderControlPanel/SnippylyRecorderControlPanel.d.ts +8 -0
  76. package/esm/types/components/SnippylyRecorderControlPanel/index.d.ts +1 -0
  77. package/esm/types/components/SnippylyRecorderNotes/SnippylyRecorderNotes.d.ts +5 -0
  78. package/esm/types/components/SnippylyRecorderNotes/index.d.ts +1 -0
  79. package/esm/types/components/SnippylyRecorderPlayer/SnippylyRecorderPlayer.d.ts +12 -0
  80. package/esm/types/components/SnippylyRecorderPlayer/index.d.ts +1 -0
  81. package/esm/types/components/SnippylyRecorderTool/SnippylyRecorderTool.d.ts +8 -0
  82. package/esm/types/components/SnippylyRecorderTool/index.d.ts +1 -0
  83. package/esm/types/components/SnippylySidebarButton/SnippylySidebarButton.d.ts +6 -0
  84. package/esm/types/components/SnippylySidebarButton/index.d.ts +1 -0
  85. package/esm/types/components/SnippylyTagTool/SnippylyTagTool.d.ts +6 -0
  86. package/esm/types/components/SnippylyTagTool/index.d.ts +1 -0
  87. package/esm/types/components/SnippylyTags/SnippylyTags.d.ts +6 -0
  88. package/esm/types/components/SnippylyTags/index.d.ts +1 -0
  89. package/esm/types/components/SnippylyUserInviteTool/SnippylyUserInviteTool.d.ts +10 -0
  90. package/esm/types/components/SnippylyUserInviteTool/index.d.ts +1 -0
  91. package/esm/types/components/SnippylyUserRequestTool/SnippylyUserRequestTool.d.ts +11 -0
  92. package/esm/types/components/SnippylyUserRequestTool/index.d.ts +1 -0
  93. package/esm/types/components/index.d.ts +20 -0
  94. package/esm/types/constants.d.ts +1 -0
  95. package/esm/types/context/SnippylyContext.d.ts +8 -0
  96. package/esm/types/context/index.d.ts +1 -0
  97. package/esm/types/index.d.ts +3 -0
  98. package/esm/types/loadSnippyly.d.ts +2 -0
  99. package/index.d.ts +295 -0
  100. package/package.json +19 -0
@@ -0,0 +1,134 @@
1
+ import React from 'react';
2
+ export interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
3
+ streamViewContainerId?: string;
4
+ /**
5
+ * @deprecated
6
+ */
7
+ pinHighlighterClass?: string;
8
+ /**
9
+ * @deprecated
10
+ */
11
+ textHighlighterClass?: string;
12
+ autoCategorize?: boolean;
13
+ /**
14
+ * @deprecated Use `onSignIn` instead
15
+ */
16
+ signIn?: Function;
17
+ onSignIn?: Function;
18
+ textMode?: boolean;
19
+ popoverMode?: boolean;
20
+ /**
21
+ * @deprecated Use `floatingMode` instead
22
+ */
23
+ floatingCommentsMode?: boolean;
24
+ floatingMode?: boolean;
25
+ moderatorMode?: boolean;
26
+ streamMode?: boolean;
27
+ signInButton?: boolean;
28
+ /**
29
+ * @deprecated Use `attachments` instead
30
+ */
31
+ allowAttachments?: boolean;
32
+ attachments?: boolean;
33
+ /**
34
+ * @deprecated Use `deviceInfo` instead
35
+ */
36
+ showDeviceInfo?: boolean;
37
+ deviceInfo?: boolean;
38
+ /**
39
+ * @deprecated Use `commentIndex` instead
40
+ */
41
+ showCommentIndex?: boolean;
42
+ commentIndex?: boolean;
43
+ dialogOnHover?: boolean;
44
+ dialogOnTargetElementClick?: boolean;
45
+ /**
46
+ * @deprecated Use `priority` instead
47
+ */
48
+ showPriority?: boolean;
49
+ priority?: boolean;
50
+ /**
51
+ * @deprecated Use `status` instead
52
+ */
53
+ showStatus?: boolean;
54
+ status?: boolean;
55
+ /**
56
+ * @deprecated Use `resolveButton` instead
57
+ */
58
+ showResolveButton?: boolean;
59
+ resolveButton?: boolean;
60
+ inboxMode?: boolean;
61
+ suggestionMode?: boolean;
62
+ ghostComments?: boolean;
63
+ /**
64
+ * @deprecated Use `ghostCommentsIndicator` instead
65
+ */
66
+ ghostCommentsMessage?: boolean;
67
+ ghostCommentsIndicator?: boolean;
68
+ allowedElementIds?: string[];
69
+ commentAdded?: Function;
70
+ onCustomPinInject?: Function;
71
+ onCommentUpdate?: Function;
72
+ /**
73
+ * @deprecated Use `onCommentAccept` instead
74
+ */
75
+ commentAccepted?: Function;
76
+ onCommentAccept?: Function;
77
+ /**
78
+ * @deprecated Use `onCommentReject` instead
79
+ */
80
+ commentRejected?: Function;
81
+ onCommentReject?: Function;
82
+ /**
83
+ * @deprecated Use `customStatus` instead
84
+ */
85
+ customStatuses?: {
86
+ id: string;
87
+ color: string;
88
+ name: string;
89
+ type: 'default' | 'ongoing' | 'terminal';
90
+ lightColor?: string;
91
+ svg?: string;
92
+ iconUrl?: string;
93
+ }[];
94
+ customStatus?: {
95
+ id: string;
96
+ color: string;
97
+ name: string;
98
+ type: 'default' | 'ongoing' | 'terminal';
99
+ lightColor?: string;
100
+ svg?: string;
101
+ iconUrl?: string;
102
+ }[];
103
+ /**
104
+ * @deprecated Use `customPriority` instead
105
+ */
106
+ customPriorities?: {
107
+ id: string;
108
+ color: string;
109
+ name: string;
110
+ lightColor?: string;
111
+ }[];
112
+ customPriority?: {
113
+ id: string;
114
+ color: string;
115
+ name: string;
116
+ lightColor?: string;
117
+ }[];
118
+ /**
119
+ * @deprecated Use `customCategory` instead
120
+ */
121
+ customCategories?: {
122
+ id: string;
123
+ color: string;
124
+ name: string;
125
+ }[];
126
+ customCategory?: {
127
+ id: string;
128
+ color: string;
129
+ name: string;
130
+ }[];
131
+ darkMode?: boolean;
132
+ }
133
+ declare const SnippylyComments: React.FC<IVeltCommentsProps>;
134
+ export default SnippylyComments;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyComments";
@@ -0,0 +1,17 @@
1
+ import React from 'react';
2
+ export interface IVeltCommentsSidebarProps {
3
+ embedMode?: boolean;
4
+ /**
5
+ * @deprecated Use `urlNavigation` instead
6
+ */
7
+ enableUrlNavigation?: boolean;
8
+ urlNavigation?: boolean;
9
+ /**
10
+ * @deprecated Use `onSidebarOpen` instead
11
+ */
12
+ openSidebar?: Function;
13
+ onSidebarOpen?: Function;
14
+ onSidebarCommentClick?: Function;
15
+ }
16
+ declare const SnippylyCommentsSidebar: React.FC<IVeltCommentsSidebarProps>;
17
+ export default SnippylyCommentsSidebar;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyCommentsSidebar";
@@ -0,0 +1,13 @@
1
+ import React from 'react';
2
+ export interface IVeltCursorProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
3
+ avatarMode?: boolean;
4
+ inactivityTime?: number;
5
+ allowedElementIds?: string;
6
+ /**
7
+ * @deprecated Use `onCursorUserChange` instead
8
+ */
9
+ onCursorUsersChanged?: Function;
10
+ onCursorUserChange?: Function;
11
+ }
12
+ declare const SnippylyCursor: React.FC<IVeltCursorProps>;
13
+ export default SnippylyCursor;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyCursor";
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ export interface IVeltHuddleProps {
3
+ }
4
+ declare const SnippylyHuddle: React.FC<IVeltHuddleProps>;
5
+ export default SnippylyHuddle;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyHuddle";
@@ -0,0 +1,6 @@
1
+ import React from 'react';
2
+ export interface IVeltHuddleToolProps {
3
+ type?: string;
4
+ }
5
+ declare const SnippylyHuddleTool: React.FC<IVeltHuddleToolProps>;
6
+ export default SnippylyHuddleTool;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyHuddleTool";
@@ -0,0 +1,25 @@
1
+ import React from 'react';
2
+ export interface IVeltPresenceProps {
3
+ maxUsers?: number;
4
+ inactivityTime?: number;
5
+ documentParams?: any;
6
+ location?: any;
7
+ /**
8
+ * @deprecated Use `onPresenceUserChange` instead
9
+ */
10
+ onUsersChanged?: Function;
11
+ onPresenceUserChange?: Function;
12
+ flockMode?: boolean;
13
+ /**
14
+ * @deprecated Use `defaultFlockNavigation` instead
15
+ */
16
+ disableFlockNavigation?: boolean;
17
+ defaultFlockNavigation?: boolean;
18
+ onNavigate?: (pageInfo: {
19
+ path: string;
20
+ url: string;
21
+ baseUrl: string;
22
+ }) => void;
23
+ }
24
+ declare const SnippylyPresence: React.FC<IVeltPresenceProps>;
25
+ export default SnippylyPresence;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyPresence";
@@ -0,0 +1,8 @@
1
+ import React from 'react';
2
+ export interface IVeltRecorderControlPanelProps {
3
+ mode?: string;
4
+ panelId?: string;
5
+ onRecordedData?: Function;
6
+ }
7
+ declare const SnippylyRecorderControlPanel: React.FC<IVeltRecorderControlPanelProps>;
8
+ export default SnippylyRecorderControlPanel;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyRecorderControlPanel";
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ export interface IVeltRecorderNotesProps {
3
+ }
4
+ declare const SnippylyRecorderNotes: React.FC<IVeltRecorderNotesProps>;
5
+ export default SnippylyRecorderNotes;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyRecorderNotes";
@@ -0,0 +1,12 @@
1
+ import React from 'react';
2
+ export interface IVeltRecorderPlayerProps {
3
+ recorderId?: string;
4
+ onDelete?: Function;
5
+ /**
6
+ * @deprecated Use `summary` instead.
7
+ */
8
+ showSummary?: boolean;
9
+ summary?: boolean;
10
+ }
11
+ declare const SnippylyRecorderPlayer: React.FC<IVeltRecorderPlayerProps>;
12
+ export default SnippylyRecorderPlayer;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyRecorderPlayer";
@@ -0,0 +1,8 @@
1
+ import React from 'react';
2
+ export interface IVeltRecorderToolProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
3
+ type?: string;
4
+ panelId?: string;
5
+ buttonLabel?: string;
6
+ }
7
+ declare const SnippylyRecorderTool: React.FC<IVeltRecorderToolProps>;
8
+ export default SnippylyRecorderTool;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyRecorderTool";
@@ -0,0 +1,6 @@
1
+ import React from 'react';
2
+ export interface IVeltSidebarButtonProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
3
+ tooltipText?: string;
4
+ }
5
+ declare const SnippylySidebarButton: React.FC<IVeltSidebarButtonProps>;
6
+ export default SnippylySidebarButton;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylySidebarButton";
@@ -0,0 +1,6 @@
1
+ import React from 'react';
2
+ export interface IVeltTagToolProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
3
+ targetTagElementId?: string;
4
+ }
5
+ declare const SnippylyTagTool: React.FC<IVeltTagToolProps>;
6
+ export default SnippylyTagTool;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyTagTool";
@@ -0,0 +1,6 @@
1
+ import React from 'react';
2
+ export interface IVeltTagsProps {
3
+ pinHighlighterClass?: string;
4
+ }
5
+ declare const SnippylyTags: React.FC<IVeltTagsProps>;
6
+ export default SnippylyTags;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyTags";
@@ -0,0 +1,10 @@
1
+ import React from 'react';
2
+ export interface IVeltUserInviteToolProps {
3
+ type?: string;
4
+ source?: string;
5
+ title?: string;
6
+ placeholder?: string;
7
+ accessControlDropdown?: boolean;
8
+ }
9
+ declare const SnippylyUserInviteTool: React.FC<IVeltUserInviteToolProps>;
10
+ export default SnippylyUserInviteTool;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyUserInviteTool";
@@ -0,0 +1,11 @@
1
+ import React from 'react';
2
+ export interface IVeltUserRequestToolProps {
3
+ /**
4
+ * Allowed values: 'feedback', 'reportBug', 'contactUs'
5
+ *
6
+ * Default value: 'feedback'
7
+ */
8
+ type?: string;
9
+ }
10
+ declare const SnippylyUserRequestTool: React.FC<IVeltUserRequestToolProps>;
11
+ export default SnippylyUserRequestTool;
@@ -0,0 +1 @@
1
+ export { default } from "./SnippylyUserRequestTool";
@@ -0,0 +1,20 @@
1
+ export { default as VeltProvider } from "./Snippyly";
2
+ export { default as VeltCommentBubble } from "./SnippylyCommentBubble";
3
+ export { default as VeltComments } from "./SnippylyComments";
4
+ export { default as VeltCommentsSidebar } from "./SnippylyCommentsSidebar";
5
+ export { default as VeltCommentTool } from "./SnippylyCommentTool";
6
+ export { default as VeltCursor } from "./SnippylyCursor";
7
+ export { default as VeltHuddle } from "./SnippylyHuddle";
8
+ export { default as VeltHuddleTool } from "./SnippylyHuddleTool";
9
+ export { default as VeltPresence } from "./SnippylyPresence";
10
+ export { default as VeltRecorderControlPanel } from "./SnippylyRecorderControlPanel";
11
+ export { default as VeltRecorderNotes } from "./SnippylyRecorderNotes";
12
+ export { default as VeltRecorderPlayer } from "./SnippylyRecorderPlayer";
13
+ export { default as VeltRecorderTool } from "./SnippylyRecorderTool";
14
+ export { default as VeltSidebarButton } from "./SnippylySidebarButton";
15
+ export { default as VeltTags } from "./SnippylyTags";
16
+ export { default as VeltTagTool } from "./SnippylyTagTool";
17
+ export { default as VeltArrows } from "./SnippylyArrows";
18
+ export { default as VeltArrowTool } from "./SnippylyArrowTool";
19
+ export { default as VeltUserInviteTool } from "./SnippylyUserInviteTool";
20
+ export { default as VeltUserRequestTool } from "./SnippylyUserRequestTool";
@@ -0,0 +1 @@
1
+ export declare const VELT_SDK_VERSION = "1.0.0";
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ import { Snippyly } from '@snippyly/types';
3
+ export declare const VeltContext: import("react").Context<{
4
+ client: Snippyly;
5
+ }>;
6
+ export declare function useVeltClient(): {
7
+ client: Snippyly;
8
+ };
@@ -0,0 +1 @@
1
+ export { useVeltClient } from './SnippylyContext';
@@ -0,0 +1,3 @@
1
+ export * from './components';
2
+ export * from './loadSnippyly';
3
+ export * from './context';
@@ -0,0 +1,2 @@
1
+ declare const loadVelt: (callback: Function, version?: string, staging?: boolean) => void;
2
+ export default loadVelt;