@atlaskit/flag 17.5.6 → 17.5.8
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
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# @atlaskit/flag
|
|
2
2
|
|
|
3
|
+
## 17.5.8
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
|
|
9
|
+
## 17.5.7
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`b74a80c366de2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b74a80c366de2) -
|
|
14
|
+
Allow setting custom auto-dismiss duration for AutoDismiss flag
|
|
15
|
+
|
|
3
16
|
## 17.5.6
|
|
4
17
|
|
|
5
18
|
### Patch Changes
|
|
@@ -29,7 +29,9 @@ var AutoDismissFlag = function AutoDismissFlag(props) {
|
|
|
29
29
|
var id = props.id,
|
|
30
30
|
analyticsContext = props.analyticsContext,
|
|
31
31
|
_props$onDismissed = props.onDismissed,
|
|
32
|
-
onDismissedProp = _props$onDismissed === void 0 ? _noop.default : _props$onDismissed
|
|
32
|
+
onDismissedProp = _props$onDismissed === void 0 ? _noop.default : _props$onDismissed,
|
|
33
|
+
_props$autoDismissSec = props.autoDismissSeconds,
|
|
34
|
+
autoDismissSeconds = _props$autoDismissSec === void 0 ? AUTO_DISMISS_SECONDS : _props$autoDismissSec;
|
|
33
35
|
var autoDismissTimer = (0, _react.useRef)(null);
|
|
34
36
|
var _useFlagGroup = (0, _flagGroup.useFlagGroup)(),
|
|
35
37
|
onDismissedFromFlagGroup = _useFlagGroup.onDismissed,
|
|
@@ -63,8 +65,8 @@ var AutoDismissFlag = function AutoDismissFlag(props) {
|
|
|
63
65
|
return;
|
|
64
66
|
}
|
|
65
67
|
stopAutoDismissTimer();
|
|
66
|
-
autoDismissTimer.current = window.setTimeout(dismissFlag,
|
|
67
|
-
}, [dismissFlag, stopAutoDismissTimer, isAutoDismissAllowed]);
|
|
68
|
+
autoDismissTimer.current = window.setTimeout(dismissFlag, autoDismissSeconds * 1000);
|
|
69
|
+
}, [dismissFlag, stopAutoDismissTimer, isAutoDismissAllowed, autoDismissSeconds]);
|
|
68
70
|
(0, _react.useEffect)(function () {
|
|
69
71
|
startAutoDismissTimer();
|
|
70
72
|
return stopAutoDismissTimer;
|
|
@@ -20,7 +20,8 @@ const AutoDismissFlag = props => {
|
|
|
20
20
|
const {
|
|
21
21
|
id,
|
|
22
22
|
analyticsContext,
|
|
23
|
-
onDismissed: onDismissedProp = noop
|
|
23
|
+
onDismissed: onDismissedProp = noop,
|
|
24
|
+
autoDismissSeconds = AUTO_DISMISS_SECONDS
|
|
24
25
|
} = props;
|
|
25
26
|
const autoDismissTimer = useRef(null);
|
|
26
27
|
const {
|
|
@@ -56,8 +57,8 @@ const AutoDismissFlag = props => {
|
|
|
56
57
|
return;
|
|
57
58
|
}
|
|
58
59
|
stopAutoDismissTimer();
|
|
59
|
-
autoDismissTimer.current = window.setTimeout(dismissFlag,
|
|
60
|
-
}, [dismissFlag, stopAutoDismissTimer, isAutoDismissAllowed]);
|
|
60
|
+
autoDismissTimer.current = window.setTimeout(dismissFlag, autoDismissSeconds * 1000);
|
|
61
|
+
}, [dismissFlag, stopAutoDismissTimer, isAutoDismissAllowed, autoDismissSeconds]);
|
|
61
62
|
useEffect(() => {
|
|
62
63
|
startAutoDismissTimer();
|
|
63
64
|
return stopAutoDismissTimer;
|
|
@@ -20,7 +20,9 @@ var AutoDismissFlag = function AutoDismissFlag(props) {
|
|
|
20
20
|
var id = props.id,
|
|
21
21
|
analyticsContext = props.analyticsContext,
|
|
22
22
|
_props$onDismissed = props.onDismissed,
|
|
23
|
-
onDismissedProp = _props$onDismissed === void 0 ? noop : _props$onDismissed
|
|
23
|
+
onDismissedProp = _props$onDismissed === void 0 ? noop : _props$onDismissed,
|
|
24
|
+
_props$autoDismissSec = props.autoDismissSeconds,
|
|
25
|
+
autoDismissSeconds = _props$autoDismissSec === void 0 ? AUTO_DISMISS_SECONDS : _props$autoDismissSec;
|
|
24
26
|
var autoDismissTimer = useRef(null);
|
|
25
27
|
var _useFlagGroup = useFlagGroup(),
|
|
26
28
|
onDismissedFromFlagGroup = _useFlagGroup.onDismissed,
|
|
@@ -54,8 +56,8 @@ var AutoDismissFlag = function AutoDismissFlag(props) {
|
|
|
54
56
|
return;
|
|
55
57
|
}
|
|
56
58
|
stopAutoDismissTimer();
|
|
57
|
-
autoDismissTimer.current = window.setTimeout(dismissFlag,
|
|
58
|
-
}, [dismissFlag, stopAutoDismissTimer, isAutoDismissAllowed]);
|
|
59
|
+
autoDismissTimer.current = window.setTimeout(dismissFlag, autoDismissSeconds * 1000);
|
|
60
|
+
}, [dismissFlag, stopAutoDismissTimer, isAutoDismissAllowed, autoDismissSeconds]);
|
|
59
61
|
useEffect(function () {
|
|
60
62
|
startAutoDismissTimer();
|
|
61
63
|
return stopAutoDismissTimer;
|
package/dist/types/types.d.ts
CHANGED
|
@@ -86,6 +86,12 @@ type AutoDismissFlagPropsWithoutId = {
|
|
|
86
86
|
* Milliseconds to delay the screen reader announcement due to announcement conflict.
|
|
87
87
|
*/
|
|
88
88
|
delayAnnouncement?: number;
|
|
89
|
+
/**
|
|
90
|
+
* Duration in seconds before flag gets auto dismissed.
|
|
91
|
+
* Default is 8 seconds. For a11y reasons 8s is also a strongly-suggested minimum.
|
|
92
|
+
* Only applies to auto-dismissable flags.
|
|
93
|
+
*/
|
|
94
|
+
autoDismissSeconds?: number;
|
|
89
95
|
};
|
|
90
96
|
export interface AutoDismissFlagProps extends AutoDismissFlagPropsWithoutId, FlagPropsId {
|
|
91
97
|
}
|
|
@@ -86,6 +86,12 @@ type AutoDismissFlagPropsWithoutId = {
|
|
|
86
86
|
* Milliseconds to delay the screen reader announcement due to announcement conflict.
|
|
87
87
|
*/
|
|
88
88
|
delayAnnouncement?: number;
|
|
89
|
+
/**
|
|
90
|
+
* Duration in seconds before flag gets auto dismissed.
|
|
91
|
+
* Default is 8 seconds. For a11y reasons 8s is also a strongly-suggested minimum.
|
|
92
|
+
* Only applies to auto-dismissable flags.
|
|
93
|
+
*/
|
|
94
|
+
autoDismissSeconds?: number;
|
|
89
95
|
};
|
|
90
96
|
export interface AutoDismissFlagProps extends AutoDismissFlagPropsWithoutId, FlagPropsId {
|
|
91
97
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/flag",
|
|
3
|
-
"version": "17.5.
|
|
3
|
+
"version": "17.5.8",
|
|
4
4
|
"description": "A flag is used for confirmations, alerts, and acknowledgments that require minimal user interaction, often displayed using a flag group.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -34,16 +34,16 @@
|
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"@atlaskit/analytics-next": "^11.1.0",
|
|
36
36
|
"@atlaskit/button": "^23.6.0",
|
|
37
|
-
"@atlaskit/css": "^0.
|
|
38
|
-
"@atlaskit/ds-lib": "^5.
|
|
37
|
+
"@atlaskit/css": "^0.17.0",
|
|
38
|
+
"@atlaskit/ds-lib": "^5.3.0",
|
|
39
39
|
"@atlaskit/heading": "^5.2.0",
|
|
40
40
|
"@atlaskit/icon": "^29.0.0",
|
|
41
41
|
"@atlaskit/motion": "^5.3.0",
|
|
42
42
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
43
43
|
"@atlaskit/portal": "^5.1.0",
|
|
44
|
-
"@atlaskit/primitives": "^16.
|
|
44
|
+
"@atlaskit/primitives": "^16.3.0",
|
|
45
45
|
"@atlaskit/theme": "^21.0.0",
|
|
46
|
-
"@atlaskit/tokens": "^8.
|
|
46
|
+
"@atlaskit/tokens": "^8.3.0",
|
|
47
47
|
"@atlaskit/visually-hidden": "^3.0.0",
|
|
48
48
|
"@babel/runtime": "^7.0.0",
|
|
49
49
|
"@compiled/react": "^0.18.6"
|