@atlaskit/reactions 33.2.12 → 33.2.13
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.
- package/CHANGELOG.md +8 -0
- package/afm-cc/tsconfig.json +2 -2
- package/dist/cjs/analytics/index.js +1 -1
- package/dist/es2019/analytics/index.js +1 -1
- package/dist/esm/analytics/index.js +1 -1
- package/dist/types/components/Counter.d.ts +10 -10
- package/dist/types/components/EmojiButton.d.ts +4 -4
- package/dist/types/components/Reaction.d.ts +20 -20
- package/dist/types/components/ReactionButton.d.ts +9 -9
- package/dist/types/components/ReactionPicker.d.ts +34 -34
- package/dist/types/components/ReactionPickerNew.d.ts +41 -41
- package/dist/types/components/ReactionSummaryButton.d.ts +12 -12
- package/dist/types/components/ReactionSummaryView.d.ts +32 -32
- package/dist/types/components/ReactionTooltip.d.ts +14 -14
- package/dist/types/components/ReactionView.d.ts +4 -4
- package/dist/types/components/Reactions.d.ts +73 -73
- package/dist/types/components/ReactionsDialog.d.ts +10 -10
- package/dist/types/components/ReactionsDialogHeader.d.ts +5 -5
- package/dist/types/components/ReactionsList.d.ts +7 -7
- package/dist/types/components/RepositionOnUpdate.d.ts +2 -2
- package/dist/types/components/Selector.d.ts +8 -8
- package/dist/types/components/StaticReaction.d.ts +3 -3
- package/dist/types/components/Trigger.d.ts +27 -27
- package/dist/types/components/UfoErrorBoundary.d.ts +1 -1
- package/dist/types/containers/ConnectedReactionPicker/ConnectedReactionPicker.d.ts +4 -4
- package/dist/types/containers/ConnectedReactionsView/ConnectedReactionsView.d.ts +10 -10
- package/dist/types/hooks/useFocusTrap.d.ts +1 -1
- package/dist/types/store/MemoryReactionsStore.d.ts +1 -1
- package/dist/types/store/ReactionConsumer.d.ts +4 -4
- package/dist/types/types/Actions.d.ts +8 -8
- package/dist/types/types/User.d.ts +5 -5
- package/dist/types/types/client.d.ts +10 -10
- package/dist/types/types/index.d.ts +6 -6
- package/dist/types/types/reaction.d.ts +12 -12
- package/dist/types/types/store.d.ts +6 -6
- package/dist/types-ts4.5/components/Counter.d.ts +10 -10
- package/dist/types-ts4.5/components/EmojiButton.d.ts +4 -4
- package/dist/types-ts4.5/components/Reaction.d.ts +20 -20
- package/dist/types-ts4.5/components/ReactionButton.d.ts +9 -9
- package/dist/types-ts4.5/components/ReactionPicker.d.ts +34 -34
- package/dist/types-ts4.5/components/ReactionPickerNew.d.ts +41 -41
- package/dist/types-ts4.5/components/ReactionSummaryButton.d.ts +12 -12
- package/dist/types-ts4.5/components/ReactionSummaryView.d.ts +32 -32
- package/dist/types-ts4.5/components/ReactionTooltip.d.ts +14 -14
- package/dist/types-ts4.5/components/ReactionView.d.ts +4 -4
- package/dist/types-ts4.5/components/Reactions.d.ts +73 -73
- package/dist/types-ts4.5/components/ReactionsDialog.d.ts +10 -10
- package/dist/types-ts4.5/components/ReactionsDialogHeader.d.ts +5 -5
- package/dist/types-ts4.5/components/ReactionsList.d.ts +7 -7
- package/dist/types-ts4.5/components/RepositionOnUpdate.d.ts +2 -2
- package/dist/types-ts4.5/components/Selector.d.ts +8 -8
- package/dist/types-ts4.5/components/StaticReaction.d.ts +3 -3
- package/dist/types-ts4.5/components/Trigger.d.ts +27 -27
- package/dist/types-ts4.5/components/UfoErrorBoundary.d.ts +1 -1
- package/dist/types-ts4.5/containers/ConnectedReactionPicker/ConnectedReactionPicker.d.ts +4 -4
- package/dist/types-ts4.5/containers/ConnectedReactionsView/ConnectedReactionsView.d.ts +10 -10
- package/dist/types-ts4.5/hooks/useFocusTrap.d.ts +1 -1
- package/dist/types-ts4.5/store/MemoryReactionsStore.d.ts +1 -1
- package/dist/types-ts4.5/store/ReactionConsumer.d.ts +4 -4
- package/dist/types-ts4.5/types/Actions.d.ts +8 -8
- package/dist/types-ts4.5/types/User.d.ts +5 -5
- package/dist/types-ts4.5/types/client.d.ts +10 -10
- package/dist/types-ts4.5/types/index.d.ts +6 -6
- package/dist/types-ts4.5/types/reaction.d.ts +12 -12
- package/dist/types-ts4.5/types/store.d.ts +6 -6
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# @atlaskit/reactions
|
|
2
2
|
|
|
3
|
+
## 33.2.13
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`0fdcb6f2f96fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0fdcb6f2f96fd) -
|
|
8
|
+
Sorted type and interface props to improve Atlaskit docs
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
|
|
3
11
|
## 33.2.12
|
|
4
12
|
|
|
5
13
|
### Patch Changes
|
package/afm-cc/tsconfig.json
CHANGED
|
@@ -11,7 +11,7 @@ var _analyticsGasTypes = require("@atlaskit/analytics-gas-types");
|
|
|
11
11
|
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
|
|
12
12
|
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
|
|
13
13
|
var packageName = "@atlaskit/reactions";
|
|
14
|
-
var packageVersion = "33.2.
|
|
14
|
+
var packageVersion = "33.2.12";
|
|
15
15
|
/**
|
|
16
16
|
* TODO: move to utility package?
|
|
17
17
|
* A random sampling function
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { createAndFireEvent } from '@atlaskit/analytics-next';
|
|
2
2
|
import { UI_EVENT_TYPE, OPERATIONAL_EVENT_TYPE } from '@atlaskit/analytics-gas-types';
|
|
3
3
|
const packageName = "@atlaskit/reactions";
|
|
4
|
-
const packageVersion = "33.2.
|
|
4
|
+
const packageVersion = "33.2.12";
|
|
5
5
|
/**
|
|
6
6
|
* TODO: move to utility package?
|
|
7
7
|
* A random sampling function
|
|
@@ -4,7 +4,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
|
|
|
4
4
|
import { createAndFireEvent } from '@atlaskit/analytics-next';
|
|
5
5
|
import { UI_EVENT_TYPE, OPERATIONAL_EVENT_TYPE } from '@atlaskit/analytics-gas-types';
|
|
6
6
|
var packageName = "@atlaskit/reactions";
|
|
7
|
-
var packageVersion = "33.2.
|
|
7
|
+
var packageVersion = "33.2.12";
|
|
8
8
|
/**
|
|
9
9
|
* TODO: move to utility package?
|
|
10
10
|
* A random sampling function
|
|
@@ -13,9 +13,13 @@ export declare const RENDER_COUNTER_TESTID = "counter-container";
|
|
|
13
13
|
export declare const RENDER_LABEL_TESTID = "counter_label_wrapper";
|
|
14
14
|
export interface CounterProps {
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Duration of how long the motion will take (defaults to "medium" from '@atlaskit/motion')
|
|
17
17
|
*/
|
|
18
|
-
|
|
18
|
+
animationDuration?: Durations;
|
|
19
|
+
/**
|
|
20
|
+
* Optional wrapper class name
|
|
21
|
+
*/
|
|
22
|
+
className?: string;
|
|
19
23
|
/**
|
|
20
24
|
* Has the emoji been selected by given user (defaults to false)
|
|
21
25
|
*/
|
|
@@ -28,14 +32,6 @@ export interface CounterProps {
|
|
|
28
32
|
* Label to show when the value surpasses the limit value (defaults to "1k+")
|
|
29
33
|
*/
|
|
30
34
|
overLimitLabel?: string;
|
|
31
|
-
/**
|
|
32
|
-
* Optional wrapper class name
|
|
33
|
-
*/
|
|
34
|
-
className?: string;
|
|
35
|
-
/**
|
|
36
|
-
* Duration of how long the motion will take (defaults to "medium" from '@atlaskit/motion')
|
|
37
|
-
*/
|
|
38
|
-
animationDuration?: Durations;
|
|
39
35
|
/**
|
|
40
36
|
* Optional prop to use a darker text color for the counter
|
|
41
37
|
*/
|
|
@@ -44,6 +40,10 @@ export interface CounterProps {
|
|
|
44
40
|
* Optional prop to show updated styling for counter
|
|
45
41
|
*/
|
|
46
42
|
useUpdatedStyles?: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Count of emoji been selected
|
|
45
|
+
*/
|
|
46
|
+
value: number;
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
49
|
* Display reaction count next to the emoji button
|
|
@@ -9,14 +9,14 @@ export interface EmojiButtonProps {
|
|
|
9
9
|
* Async provider to fetch the emoji
|
|
10
10
|
*/
|
|
11
11
|
emojiProvider: Promise<EmojiProvider>;
|
|
12
|
-
/**
|
|
13
|
-
* Event handler when a new emoji is selected
|
|
14
|
-
*/
|
|
15
|
-
onClick: OnEmojiEvent;
|
|
16
12
|
/**
|
|
17
13
|
* Optional prop for hoverable reaction picker selector emoji
|
|
18
14
|
*/
|
|
19
15
|
hoverableReactionPickerSelectorEmoji?: boolean;
|
|
16
|
+
/**
|
|
17
|
+
* Event handler when a new emoji is selected
|
|
18
|
+
*/
|
|
19
|
+
onClick: OnEmojiEvent;
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
22
|
* custom button to render the custom emoji selector inside the reaction picker
|
|
@@ -8,49 +8,49 @@ import { type OpenReactionsDialogOptions } from './Reactions';
|
|
|
8
8
|
export declare const RENDER_REACTION_TESTID = "render_reaction_wrapper";
|
|
9
9
|
export interface ReactionProps {
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Optional prop for enabling the Reactions Dialog
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
allowUserDialog?: boolean;
|
|
14
14
|
/**
|
|
15
15
|
* Provider for loading emojis
|
|
16
16
|
*/
|
|
17
17
|
emojiProvider: Promise<EmojiProvider>;
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Show custom animation or render as standard without animation (defaults to false)
|
|
20
20
|
*/
|
|
21
|
-
|
|
21
|
+
flash?: boolean;
|
|
22
22
|
/**
|
|
23
|
-
* Optional
|
|
23
|
+
* Optional function when the user wants to open the Reactions Dialog
|
|
24
24
|
*/
|
|
25
|
-
|
|
25
|
+
handleOpenReactionsDialog?: (options?: OpenReactionsDialogOptions) => void;
|
|
26
26
|
/**
|
|
27
|
-
* Optional
|
|
27
|
+
* Optional prop for controlling if the reactions component is view only, disabling adding reactions
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
isViewOnly?: boolean;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* event handler when the emoji button is clicked
|
|
32
32
|
*/
|
|
33
|
-
|
|
33
|
+
onClick: ReactionClick;
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Optional event when focused the reaction
|
|
36
36
|
*/
|
|
37
|
-
|
|
37
|
+
onFocused?: ReactionFocused;
|
|
38
38
|
/**
|
|
39
|
-
* Optional
|
|
39
|
+
* Optional event when the mouse cursor hovers over the reaction
|
|
40
40
|
*/
|
|
41
|
-
|
|
41
|
+
onMouseEnter?: ReactionMouseEnter;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* Data for the reaction
|
|
44
44
|
*/
|
|
45
|
-
|
|
45
|
+
reaction: ReactionSummary;
|
|
46
46
|
/**
|
|
47
|
-
* Optional
|
|
47
|
+
* Optional prop for using an opaque button background instead of a transparent background
|
|
48
48
|
*/
|
|
49
|
-
|
|
49
|
+
showOpaqueBackground?: boolean;
|
|
50
50
|
/**
|
|
51
|
-
*
|
|
51
|
+
* Show a floating emoji particle effect (usually in response to a new reaction) (defaults to false)
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
showParticleEffect?: boolean;
|
|
54
54
|
/**
|
|
55
55
|
* Optional prop for controlling if the reaction displayed is a default one and should not have a border
|
|
56
56
|
*/
|
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
import { type ReactionProps } from './Reaction';
|
|
2
2
|
interface ReactionButtonProps extends Pick<ReactionProps, 'flash'> {
|
|
3
|
-
onClick: (event: React.MouseEvent<HTMLButtonElement>) => void;
|
|
4
|
-
className?: string;
|
|
5
3
|
ariaLabel: string;
|
|
6
4
|
ariaPressed?: boolean;
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
onFocus?: (event: React.FocusEvent<HTMLButtonElement>) => void;
|
|
5
|
+
children?: React.ReactNode;
|
|
6
|
+
className?: string;
|
|
10
7
|
dataAttributes?: {
|
|
11
8
|
[key: string]: string;
|
|
12
9
|
};
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
10
|
+
onClick: (event: React.MouseEvent<HTMLButtonElement>) => void;
|
|
11
|
+
onFocus?: (event: React.FocusEvent<HTMLButtonElement>) => void;
|
|
12
|
+
onMouseEnter?: (event: React.MouseEvent<HTMLButtonElement>) => void;
|
|
13
|
+
onMouseLeave?: (event: React.MouseEvent<HTMLButtonElement>) => void;
|
|
14
|
+
reacted?: boolean;
|
|
16
15
|
showOpaqueBackground?: boolean;
|
|
16
|
+
showSubtleStyle?: boolean;
|
|
17
|
+
testId?: string;
|
|
17
18
|
useCompactStyles?: boolean;
|
|
18
|
-
reacted?: boolean;
|
|
19
19
|
}
|
|
20
20
|
export declare const ReactionButton: ({ onClick, flash, showSubtleStyle, showOpaqueBackground, useCompactStyles, reacted, ariaLabel, ariaPressed, onMouseEnter, onMouseLeave, onFocus, children, dataAttributes, testId, }: ReactionButtonProps) => JSX.Element;
|
|
21
21
|
export {};
|
|
@@ -19,55 +19,55 @@ export declare const RENDER_REACTIONPICKER_TESTID = "reactionPicker-testid";
|
|
|
19
19
|
export declare const RENDER_REACTIONPICKERPANEL_TESTID = "reactionPickerPanel-testid";
|
|
20
20
|
export interface ReactionPickerProps extends Pick<SelectorProps, 'pickerQuickReactionEmojiIds'>, Partial<Pick<TriggerProps, 'tooltipContent' | 'miniMode'>> {
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
23
|
-
*/
|
|
24
|
-
emojiProvider: Promise<EmojiProvider>;
|
|
25
|
-
/**
|
|
26
|
-
* Event callback when an emoji button is selected
|
|
27
|
-
* @param emojiId emoji unique id
|
|
28
|
-
* @param source source where the reaction was picked (either the initial default reactions or the custom reactions picker)
|
|
22
|
+
* Optional Show the "more emoji" selector icon for choosing emoji beyond the default list of emojis (defaults to false)
|
|
29
23
|
*/
|
|
30
|
-
|
|
24
|
+
allowAllEmojis?: boolean;
|
|
31
25
|
/**
|
|
32
26
|
* Optional class name
|
|
33
27
|
*/
|
|
34
28
|
className?: string;
|
|
35
|
-
/**
|
|
36
|
-
* Optional Show the "more emoji" selector icon for choosing emoji beyond the default list of emojis (defaults to false)
|
|
37
|
-
*/
|
|
38
|
-
allowAllEmojis?: boolean;
|
|
39
29
|
/**
|
|
40
30
|
* Enable/Disable the button to be clickable (defaults to false)
|
|
41
31
|
*/
|
|
42
32
|
disabled?: boolean;
|
|
43
33
|
/**
|
|
44
|
-
* Optional
|
|
34
|
+
* Optional emoji picker size to control the size of emoji picker
|
|
45
35
|
*/
|
|
46
|
-
|
|
36
|
+
emojiPickerSize?: PickerSize;
|
|
47
37
|
/**
|
|
48
|
-
*
|
|
38
|
+
* Provider for loading emojis
|
|
49
39
|
*/
|
|
50
|
-
|
|
40
|
+
emojiProvider: Promise<EmojiProvider>;
|
|
51
41
|
/**
|
|
52
|
-
* Optional
|
|
42
|
+
* Optional prop for hoverable reaction picker
|
|
53
43
|
*/
|
|
54
|
-
|
|
44
|
+
hoverableReactionPicker?: boolean;
|
|
55
45
|
/**
|
|
56
|
-
* Optional
|
|
46
|
+
* Optional prop to set a delay for the reaction picker when it opens/closes on hover
|
|
57
47
|
*/
|
|
58
|
-
|
|
48
|
+
hoverableReactionPickerDelay?: number;
|
|
59
49
|
/**
|
|
60
|
-
* Optional prop
|
|
50
|
+
* Optional prop to say if the reactions component is in a list
|
|
61
51
|
*/
|
|
62
|
-
|
|
52
|
+
isListItem?: boolean;
|
|
63
53
|
/**
|
|
64
|
-
* Optional
|
|
54
|
+
* Optional event handler when the emoji picker is clicked outside and closed
|
|
65
55
|
*/
|
|
66
|
-
|
|
56
|
+
onCancel?: () => void;
|
|
67
57
|
/**
|
|
68
|
-
* Optional
|
|
58
|
+
* Optional event handler when the emoji picker is opened
|
|
69
59
|
*/
|
|
70
|
-
|
|
60
|
+
onOpen?: () => void;
|
|
61
|
+
/**
|
|
62
|
+
* Event callback when an emoji button is selected
|
|
63
|
+
* @param emojiId emoji unique id
|
|
64
|
+
* @param source source where the reaction was picked (either the initial default reactions or the custom reactions picker)
|
|
65
|
+
*/
|
|
66
|
+
onSelection: (emojiId: string, source: ReactionSource) => void;
|
|
67
|
+
/**
|
|
68
|
+
* Optional event handler when the custom emoji picker icon is selected
|
|
69
|
+
*/
|
|
70
|
+
onShowMore?: () => void;
|
|
71
71
|
/**
|
|
72
72
|
* Optional prop for controlling the picker location
|
|
73
73
|
*/
|
|
@@ -81,27 +81,27 @@ export interface ReactionPickerProps extends Pick<SelectorProps, 'pickerQuickRea
|
|
|
81
81
|
*/
|
|
82
82
|
reactionPickerTriggerText?: string;
|
|
83
83
|
/**
|
|
84
|
-
* Optional prop
|
|
84
|
+
* Optional prop for displaying text to add a reaction
|
|
85
85
|
*/
|
|
86
|
-
|
|
86
|
+
showAddReactionText?: boolean;
|
|
87
87
|
/**
|
|
88
|
-
* Optional prop for
|
|
88
|
+
* Optional prop for using an opaque button background instead of a transparent background
|
|
89
89
|
*/
|
|
90
|
-
|
|
90
|
+
showOpaqueBackground?: boolean;
|
|
91
91
|
/**
|
|
92
|
-
* Optional prop
|
|
92
|
+
* Optional prop for applying subtle styling to reaction summary and picker
|
|
93
93
|
*/
|
|
94
|
-
|
|
94
|
+
subtleReactionsSummaryAndPicker?: boolean;
|
|
95
95
|
}
|
|
96
96
|
/**
|
|
97
97
|
* Picker component for adding reactions
|
|
98
98
|
*/
|
|
99
99
|
export declare const ReactionPicker: React.MemoExoticComponent<(props: ReactionPickerProps) => JSX.Element>;
|
|
100
100
|
export interface PopperWrapperProps {
|
|
101
|
+
popperModifiers?: PopperProps<{}>['modifiers'];
|
|
101
102
|
settings: {
|
|
102
|
-
showFullPicker: boolean;
|
|
103
103
|
popperPlacement: Placement;
|
|
104
|
+
showFullPicker: boolean;
|
|
104
105
|
};
|
|
105
|
-
popperModifiers?: PopperProps<{}>['modifiers'];
|
|
106
106
|
}
|
|
107
107
|
export declare const PopperWrapper: (props: PropsWithChildren<PopperWrapperProps>) => JSX.Element;
|
|
@@ -19,59 +19,63 @@ export declare const RENDER_REACTIONPICKER_TESTID = "reactionPicker-testid";
|
|
|
19
19
|
export declare const RENDER_REACTIONPICKERPANEL_TESTID = "reactionPickerPanel-testid";
|
|
20
20
|
export interface ReactionPickerProps extends Pick<SelectorProps, 'pickerQuickReactionEmojiIds'>, Partial<Pick<TriggerProps, 'tooltipContent' | 'miniMode'>> {
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
23
|
-
*/
|
|
24
|
-
emojiProvider: Promise<EmojiProvider>;
|
|
25
|
-
/**
|
|
26
|
-
* Event callback when an emoji button is selected
|
|
27
|
-
* @param emojiId emoji unique id
|
|
28
|
-
* @param source source where the reaction was picked (either the initial default reactions or the custom reactions picker)
|
|
22
|
+
* Optional Show the "more emoji" selector icon for choosing emoji beyond the default list of emojis (defaults to false)
|
|
29
23
|
*/
|
|
30
|
-
|
|
24
|
+
allowAllEmojis?: boolean;
|
|
31
25
|
/**
|
|
32
26
|
* Optional class name
|
|
33
27
|
*/
|
|
34
28
|
className?: string;
|
|
35
|
-
/**
|
|
36
|
-
* Optional Show the "more emoji" selector icon for choosing emoji beyond the default list of emojis (defaults to false)
|
|
37
|
-
*/
|
|
38
|
-
allowAllEmojis?: boolean;
|
|
39
29
|
/**
|
|
40
30
|
* Enable/Disable the button to be clickable (defaults to false)
|
|
41
31
|
*/
|
|
42
32
|
disabled?: boolean;
|
|
43
33
|
/**
|
|
44
|
-
* Optional
|
|
34
|
+
* Optional emoji picker size to control the size of emoji picker
|
|
45
35
|
*/
|
|
46
|
-
|
|
36
|
+
emojiPickerSize?: PickerSize;
|
|
47
37
|
/**
|
|
48
|
-
*
|
|
38
|
+
* Provider for loading emojis
|
|
49
39
|
*/
|
|
50
|
-
|
|
40
|
+
emojiProvider: Promise<EmojiProvider>;
|
|
51
41
|
/**
|
|
52
|
-
* Optional
|
|
42
|
+
* Optional prop for hoverable reaction picker
|
|
53
43
|
*/
|
|
54
|
-
|
|
44
|
+
hoverableReactionPicker?: boolean;
|
|
55
45
|
/**
|
|
56
|
-
* Optional
|
|
46
|
+
* Optional prop to set a delay for the reaction picker when it opens/closes on hover
|
|
57
47
|
*/
|
|
58
|
-
|
|
48
|
+
hoverableReactionPickerDelay?: number;
|
|
59
49
|
/**
|
|
60
|
-
* Optional prop
|
|
50
|
+
* Optional prop to say if the reactions component is in a list
|
|
61
51
|
*/
|
|
62
|
-
|
|
52
|
+
isListItem?: boolean;
|
|
63
53
|
/**
|
|
64
|
-
* Optional
|
|
54
|
+
* Optional event handler when the emoji picker is clicked outside and closed
|
|
65
55
|
*/
|
|
66
|
-
|
|
56
|
+
onCancel?: () => void;
|
|
67
57
|
/**
|
|
68
|
-
* Optional
|
|
58
|
+
* Optional event handler when the emoji picker is opened
|
|
69
59
|
*/
|
|
70
|
-
|
|
60
|
+
onOpen?: () => void;
|
|
61
|
+
/**
|
|
62
|
+
* Event callback when an emoji button is selected
|
|
63
|
+
* @param emojiId emoji unique id
|
|
64
|
+
* @param source source where the reaction was picked (either the initial default reactions or the custom reactions picker)
|
|
65
|
+
*/
|
|
66
|
+
onSelection: (emojiId: string, source: ReactionSource) => void;
|
|
67
|
+
/**
|
|
68
|
+
* Optional event handler when the custom emoji picker icon is selected
|
|
69
|
+
*/
|
|
70
|
+
onShowMore?: () => void;
|
|
71
71
|
/**
|
|
72
72
|
* Optional prop for controlling the picker location
|
|
73
73
|
*/
|
|
74
74
|
reactionPickerPlacement?: Placement;
|
|
75
|
+
/**
|
|
76
|
+
* Optional prop to set the strategy of the reaction picker popup
|
|
77
|
+
*/
|
|
78
|
+
reactionPickerStrategy?: PopperProps<{}>['strategy'];
|
|
75
79
|
/**
|
|
76
80
|
* Optional prop for controlling icon inside Trigger
|
|
77
81
|
*/
|
|
@@ -81,34 +85,30 @@ export interface ReactionPickerProps extends Pick<SelectorProps, 'pickerQuickRea
|
|
|
81
85
|
*/
|
|
82
86
|
reactionPickerTriggerText?: string;
|
|
83
87
|
/**
|
|
84
|
-
* Optional prop
|
|
85
|
-
*/
|
|
86
|
-
isListItem?: boolean;
|
|
87
|
-
/**
|
|
88
|
-
* Optional prop for hoverable reaction picker
|
|
88
|
+
* Optional prop for displaying text to add a reaction
|
|
89
89
|
*/
|
|
90
|
-
|
|
90
|
+
showAddReactionText?: boolean;
|
|
91
91
|
/**
|
|
92
|
-
* Optional prop
|
|
92
|
+
* Optional prop for using an opaque button background instead of a transparent background
|
|
93
93
|
*/
|
|
94
|
-
|
|
94
|
+
showOpaqueBackground?: boolean;
|
|
95
95
|
/**
|
|
96
|
-
* Optional prop
|
|
96
|
+
* Optional prop for applying subtle styling to reaction summary and picker
|
|
97
97
|
*/
|
|
98
|
-
|
|
98
|
+
subtleReactionsSummaryAndPicker?: boolean;
|
|
99
99
|
}
|
|
100
100
|
/**
|
|
101
101
|
* Picker component for adding reactions
|
|
102
102
|
*/
|
|
103
103
|
export declare const ReactionPicker: React.MemoExoticComponent<(props: ReactionPickerProps) => JSX.Element>;
|
|
104
104
|
export interface PopperWrapperProps {
|
|
105
|
-
triggerRef: HTMLDivElement | HTMLButtonElement | null;
|
|
106
|
-
settings: {
|
|
107
|
-
showFullPicker: boolean;
|
|
108
|
-
popperPlacement: Placement;
|
|
109
|
-
};
|
|
110
105
|
isOpen: boolean;
|
|
111
106
|
onClose: () => void;
|
|
112
107
|
popperModifiers?: PopperProps<{}>['modifiers'];
|
|
108
|
+
settings: {
|
|
109
|
+
popperPlacement: Placement;
|
|
110
|
+
showFullPicker: boolean;
|
|
111
|
+
};
|
|
112
|
+
triggerRef: HTMLDivElement | HTMLButtonElement | null;
|
|
113
113
|
}
|
|
114
114
|
export declare const PopperWrapper: (props: PropsWithChildren<PopperWrapperProps>) => JSX.Element;
|
|
@@ -1,21 +1,13 @@
|
|
|
1
1
|
import { type ReactionsProps } from './Reactions';
|
|
2
2
|
interface ReactionSummaryButtonProps extends Pick<ReactionsProps, 'emojiProvider' | 'reactions' | 'useButtonAlignmentStyling'> {
|
|
3
|
-
/**
|
|
4
|
-
* event handler when the summary button is clicked to view all reactions
|
|
5
|
-
*/
|
|
6
|
-
onClick: () => void;
|
|
7
3
|
/**
|
|
8
4
|
* The number of emojis to show in the summary button
|
|
9
5
|
*/
|
|
10
6
|
emojisToShow?: number;
|
|
11
7
|
/**
|
|
12
|
-
*
|
|
13
|
-
*/
|
|
14
|
-
showOpaqueBackground?: boolean;
|
|
15
|
-
/**
|
|
16
|
-
* Optional prop for applying subtle styling to reaction summary button
|
|
8
|
+
* event handler when the summary button is clicked to view all reactions
|
|
17
9
|
*/
|
|
18
|
-
|
|
10
|
+
onClick: () => void;
|
|
19
11
|
/**
|
|
20
12
|
* Optional event handler when mouse enters the button
|
|
21
13
|
*/
|
|
@@ -25,13 +17,21 @@ interface ReactionSummaryButtonProps extends Pick<ReactionsProps, 'emojiProvider
|
|
|
25
17
|
*/
|
|
26
18
|
onMouseLeave?: () => void;
|
|
27
19
|
/**
|
|
28
|
-
* Optional prop for
|
|
20
|
+
* Optional prop for using an opaque button background instead of a transparent background
|
|
29
21
|
*/
|
|
30
|
-
|
|
22
|
+
showOpaqueBackground?: boolean;
|
|
23
|
+
/**
|
|
24
|
+
* Optional prop for applying subtle styling to reaction summary button
|
|
25
|
+
*/
|
|
26
|
+
subtleReactionsSummaryAndPicker?: boolean;
|
|
31
27
|
/**
|
|
32
28
|
* Optional prop to add an icon to the end of the summary button
|
|
33
29
|
*/
|
|
34
30
|
summaryButtonIconAfter?: React.ReactNode;
|
|
31
|
+
/**
|
|
32
|
+
* Optional prop for the optimistic image URL
|
|
33
|
+
*/
|
|
34
|
+
summaryGetOptimisticImageURL?: (emojiId: string) => string;
|
|
35
35
|
/**
|
|
36
36
|
* Optional prop to set the most recently clicked emoji id
|
|
37
37
|
*/
|
|
@@ -8,67 +8,67 @@ import { type TriggerProps } from './Trigger';
|
|
|
8
8
|
export declare const RENDER_SUMMARY_VIEW_POPUP_TESTID = "render-summary-view-popup";
|
|
9
9
|
interface ReactionSummaryViewProps extends Pick<ReactionsProps, 'emojiProvider' | 'reactions' | 'flash' | 'particleEffectByEmoji' | 'allowUserDialog' | 'allowSelectFromSummaryView' | 'emojiPickerSize' | 'useButtonAlignmentStyling' | 'reactionPickerTriggerText'>, Pick<TriggerProps, 'tooltipContent' | 'reactionPickerTriggerIcon' | 'disabled'> {
|
|
10
10
|
/**
|
|
11
|
-
* Optional prop
|
|
12
|
-
*/
|
|
13
|
-
placement?: Placement;
|
|
14
|
-
/**
|
|
15
|
-
* event handler when a a reaction button is clicked inside the summary
|
|
11
|
+
* Optional prop for enabling the Reactions Dialog
|
|
16
12
|
*/
|
|
17
|
-
|
|
13
|
+
allowUserDialog?: boolean;
|
|
18
14
|
/**
|
|
19
|
-
*
|
|
20
|
-
* @param emojiId emoji unique id
|
|
21
|
-
* @param source source where the reaction was picked (either the initial default reactions or the custom reactions picker)
|
|
15
|
+
* Optional function when the user wants to open the Reactions Dialog
|
|
22
16
|
*/
|
|
23
|
-
|
|
17
|
+
handleOpenReactionsDialog?: (options?: OpenReactionsDialogOptions) => void;
|
|
24
18
|
/**
|
|
25
|
-
* Optional
|
|
19
|
+
* Optional prop to make the summary view open on hover
|
|
26
20
|
*/
|
|
27
|
-
|
|
21
|
+
hoverableSummaryView?: boolean;
|
|
28
22
|
/**
|
|
29
|
-
* Optional
|
|
23
|
+
* Optional prop to set a delay for the summary view when it opens/closes on hover
|
|
30
24
|
*/
|
|
31
|
-
|
|
25
|
+
hoverableSummaryViewDelay?: number;
|
|
32
26
|
/**
|
|
33
|
-
* Optional prop for
|
|
27
|
+
* Optional prop for controlling if the reactions component is view only, disabling adding reactions
|
|
34
28
|
*/
|
|
35
|
-
|
|
29
|
+
isViewOnly?: boolean;
|
|
36
30
|
/**
|
|
37
|
-
* Optional
|
|
31
|
+
* Optional event handler when the emoji picker is opened
|
|
38
32
|
*/
|
|
39
|
-
|
|
33
|
+
onOpen?: () => void;
|
|
40
34
|
/**
|
|
41
|
-
*
|
|
35
|
+
* event handler when a a reaction button is clicked inside the summary
|
|
42
36
|
*/
|
|
43
|
-
|
|
37
|
+
onReactionClick: ReactionClick;
|
|
44
38
|
/**
|
|
45
|
-
* Optional
|
|
39
|
+
* Optional event when focused a reaction inside the summary
|
|
46
40
|
*/
|
|
47
|
-
|
|
41
|
+
onReactionFocused?: ReactionFocused;
|
|
48
42
|
/**
|
|
49
|
-
* Optional
|
|
43
|
+
* Optional event when the mouse cursor hovers over a reaction button inside the summary
|
|
50
44
|
*/
|
|
51
|
-
|
|
45
|
+
onReactionMouseEnter?: ReactionMouseEnter;
|
|
52
46
|
/**
|
|
53
|
-
*
|
|
47
|
+
* Event callback when an emoji button is selected
|
|
48
|
+
* @param emojiId emoji unique id
|
|
49
|
+
* @param source source where the reaction was picked (either the initial default reactions or the custom reactions picker)
|
|
54
50
|
*/
|
|
55
|
-
|
|
51
|
+
onSelection: (emojiId: string, source: ReactionSource) => void;
|
|
56
52
|
/**
|
|
57
|
-
* Optional prop to
|
|
53
|
+
* Optional prop to change the placement of the summary popup reaction list
|
|
58
54
|
*/
|
|
59
|
-
|
|
55
|
+
placement?: Placement;
|
|
60
56
|
/**
|
|
61
|
-
* Optional prop
|
|
57
|
+
* Optional prop for using an opaque button background instead of a transparent background
|
|
62
58
|
*/
|
|
63
|
-
|
|
59
|
+
showOpaqueBackground?: boolean;
|
|
64
60
|
/**
|
|
65
|
-
* Optional prop for
|
|
61
|
+
* Optional prop for applying subtle styling to reaction picker
|
|
66
62
|
*/
|
|
67
|
-
|
|
63
|
+
subtleReactionsSummaryAndPicker?: boolean;
|
|
68
64
|
/**
|
|
69
65
|
* Optional prop to control if the side picker is shown
|
|
70
66
|
*/
|
|
71
67
|
summaryButtonIconAfter?: React.ReactNode;
|
|
68
|
+
/**
|
|
69
|
+
* Optional prop for the optimistic image URL
|
|
70
|
+
*/
|
|
71
|
+
summaryGetOptimisticImageURL?: (emojiId: string) => string;
|
|
72
72
|
/**
|
|
73
73
|
* Optional prop to set the most recently clicked id
|
|
74
74
|
*/
|