@atlaskit/blanket 15.0.33 → 16.0.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.
- package/CHANGELOG.md +32 -0
- package/blanket.docs.tsx +40 -38
- package/dist/cjs/blanket.js +1 -1
- package/dist/es2019/blanket.js +1 -1
- package/dist/esm/blanket.js +1 -1
- package/package.json +15 -23
- package/types/package.json +1 -8
- package/dist/types-ts4.5/blanket.d.ts +0 -15
- package/dist/types-ts4.5/entry-points/types.d.ts +0 -1
- package/dist/types-ts4.5/index.d.ts +0 -2
- package/dist/types-ts4.5/types.d.ts +0 -30
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# @atlaskit/blanket
|
|
2
2
|
|
|
3
|
+
## 16.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
|
|
8
|
+
Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
|
|
9
|
+
|
|
10
|
+
Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
|
|
11
|
+
|
|
12
|
+
Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
|
|
13
|
+
|
|
14
|
+
```diff
|
|
15
|
+
- "typesVersions": {
|
|
16
|
+
- ">=4.5 <4.9": {
|
|
17
|
+
- "*": [
|
|
18
|
+
- "dist/types-ts4.5/*",
|
|
19
|
+
- "dist/types-ts4.5/index.d.ts"
|
|
20
|
+
- ]
|
|
21
|
+
- }
|
|
22
|
+
- },
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Patch Changes
|
|
26
|
+
|
|
27
|
+
- Updated dependencies
|
|
28
|
+
|
|
29
|
+
## 15.0.34
|
|
30
|
+
|
|
31
|
+
### Patch Changes
|
|
32
|
+
|
|
33
|
+
- Updated dependencies
|
|
34
|
+
|
|
3
35
|
## 15.0.33
|
|
4
36
|
|
|
5
37
|
### Patch Changes
|
package/blanket.docs.tsx
CHANGED
|
@@ -1,46 +1,48 @@
|
|
|
1
1
|
import path from 'path';
|
|
2
2
|
|
|
3
|
-
import type {
|
|
3
|
+
import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
|
|
4
4
|
|
|
5
|
-
const documentation:
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
description:
|
|
9
|
-
'A component for creating overlay backgrounds behind modals and other layered content.',
|
|
10
|
-
status: 'general-availability',
|
|
11
|
-
import: {
|
|
5
|
+
const documentation: StructuredContentSource = {
|
|
6
|
+
components: [
|
|
7
|
+
{
|
|
12
8
|
name: 'Blanket',
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
},
|
|
18
|
-
usageGuidelines: [
|
|
19
|
-
'Use behind modals and overlays',
|
|
20
|
-
'Consider click-to-dismiss behavior',
|
|
21
|
-
'Use appropriate tinting for context',
|
|
22
|
-
'Ensure proper z-index layering',
|
|
23
|
-
],
|
|
24
|
-
contentGuidelines: [
|
|
25
|
-
'Use consistently across similar overlay contexts',
|
|
26
|
-
'Consider visual hierarchy with overlays',
|
|
27
|
-
'Ensure appropriate contrast with content',
|
|
28
|
-
],
|
|
29
|
-
accessibilityGuidelines: [
|
|
30
|
-
"Ensure blanket doesn't interfere with focus management",
|
|
31
|
-
'Provide appropriate click handling for dismissal',
|
|
32
|
-
'Consider screen reader experience with overlays',
|
|
33
|
-
],
|
|
34
|
-
examples: [
|
|
35
|
-
{
|
|
9
|
+
description:
|
|
10
|
+
'A component for creating overlay backgrounds behind modals and other layered content.',
|
|
11
|
+
status: 'general-availability',
|
|
12
|
+
import: {
|
|
36
13
|
name: 'Blanket',
|
|
37
|
-
|
|
38
|
-
|
|
14
|
+
package: '@atlaskit/blanket',
|
|
15
|
+
type: 'default',
|
|
16
|
+
packagePath: path.resolve(__dirname),
|
|
17
|
+
packageJson: require('./package.json'),
|
|
39
18
|
},
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
19
|
+
usageGuidelines: [
|
|
20
|
+
'Use behind modals and overlays',
|
|
21
|
+
'Consider click-to-dismiss behavior',
|
|
22
|
+
'Use appropriate tinting for context',
|
|
23
|
+
'Ensure proper z-index layering',
|
|
24
|
+
],
|
|
25
|
+
contentGuidelines: [
|
|
26
|
+
'Use consistently across similar overlay contexts',
|
|
27
|
+
'Consider visual hierarchy with overlays',
|
|
28
|
+
'Ensure appropriate contrast with content',
|
|
29
|
+
],
|
|
30
|
+
accessibilityGuidelines: [
|
|
31
|
+
"Ensure blanket doesn't interfere with focus management",
|
|
32
|
+
'Provide appropriate click handling for dismissal',
|
|
33
|
+
'Consider screen reader experience with overlays',
|
|
34
|
+
],
|
|
35
|
+
examples: [
|
|
36
|
+
{
|
|
37
|
+
name: 'Blanket',
|
|
38
|
+
description: 'Blanket example',
|
|
39
|
+
source: path.resolve(__dirname, './examples/ai/blanket.tsx'),
|
|
40
|
+
},
|
|
41
|
+
],
|
|
42
|
+
keywords: ['blanket', 'overlay', 'backdrop', 'modal', 'layer'],
|
|
43
|
+
categories: ['overlay'],
|
|
44
|
+
},
|
|
45
|
+
],
|
|
46
|
+
};
|
|
45
47
|
|
|
46
48
|
export default documentation;
|
package/dist/cjs/blanket.js
CHANGED
|
@@ -19,7 +19,7 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
|
|
|
19
19
|
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; }
|
|
20
20
|
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; }
|
|
21
21
|
var packageName = "@atlaskit/blanket";
|
|
22
|
-
var packageVersion = "15.0.
|
|
22
|
+
var packageVersion = "15.0.34";
|
|
23
23
|
var analyticsAttributes = {
|
|
24
24
|
componentName: 'blanket',
|
|
25
25
|
packageName: packageName,
|
package/dist/es2019/blanket.js
CHANGED
|
@@ -7,7 +7,7 @@ import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next/usePlatfor
|
|
|
7
7
|
import noop from '@atlaskit/ds-lib/noop';
|
|
8
8
|
import { layers } from '@atlaskit/theme/constants';
|
|
9
9
|
const packageName = "@atlaskit/blanket";
|
|
10
|
-
const packageVersion = "15.0.
|
|
10
|
+
const packageVersion = "15.0.34";
|
|
11
11
|
const analyticsAttributes = {
|
|
12
12
|
componentName: 'blanket',
|
|
13
13
|
packageName,
|
package/dist/esm/blanket.js
CHANGED
|
@@ -10,7 +10,7 @@ import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next/usePlatfor
|
|
|
10
10
|
import noop from '@atlaskit/ds-lib/noop';
|
|
11
11
|
import { layers } from '@atlaskit/theme/constants';
|
|
12
12
|
var packageName = "@atlaskit/blanket";
|
|
13
|
-
var packageVersion = "15.0.
|
|
13
|
+
var packageVersion = "15.0.34";
|
|
14
14
|
var analyticsAttributes = {
|
|
15
15
|
componentName: 'blanket',
|
|
16
16
|
packageName: packageName,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/blanket",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "16.0.0",
|
|
4
4
|
"description": "A blanket covers the underlying UI for a layered component, such as a modal dialog or a tooltip.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -12,14 +12,6 @@
|
|
|
12
12
|
"module": "dist/esm/index.js",
|
|
13
13
|
"module:es2019": "dist/es2019/index.js",
|
|
14
14
|
"types": "dist/types/index.d.ts",
|
|
15
|
-
"typesVersions": {
|
|
16
|
-
">=4.5 <4.9": {
|
|
17
|
-
"*": [
|
|
18
|
-
"dist/types-ts4.5/*",
|
|
19
|
-
"dist/types-ts4.5/index.d.ts"
|
|
20
|
-
]
|
|
21
|
-
}
|
|
22
|
-
},
|
|
23
15
|
"sideEffects": [
|
|
24
16
|
"**/*.compiled.css"
|
|
25
17
|
],
|
|
@@ -40,11 +32,11 @@
|
|
|
40
32
|
}
|
|
41
33
|
},
|
|
42
34
|
"dependencies": {
|
|
43
|
-
"@atlaskit/analytics-next": "^
|
|
44
|
-
"@atlaskit/css": "^0.
|
|
45
|
-
"@atlaskit/ds-lib": "^
|
|
46
|
-
"@atlaskit/theme": "^
|
|
47
|
-
"@atlaskit/tokens": "^
|
|
35
|
+
"@atlaskit/analytics-next": "^12.0.0",
|
|
36
|
+
"@atlaskit/css": "^1.0.0",
|
|
37
|
+
"@atlaskit/ds-lib": "^8.0.0",
|
|
38
|
+
"@atlaskit/theme": "^26.0.0",
|
|
39
|
+
"@atlaskit/tokens": "^14.0.0",
|
|
48
40
|
"@babel/runtime": "^7.0.0",
|
|
49
41
|
"@compiled/react": "^0.20.0"
|
|
50
42
|
},
|
|
@@ -54,15 +46,15 @@
|
|
|
54
46
|
"devDependencies": {
|
|
55
47
|
"@af/accessibility-testing": "workspace:^",
|
|
56
48
|
"@af/integration-testing": "workspace:^",
|
|
57
|
-
"@atlaskit/badge": "^
|
|
58
|
-
"@atlaskit/button": "^
|
|
59
|
-
"@atlaskit/docs": "^
|
|
60
|
-
"@atlaskit/heading": "^
|
|
61
|
-
"@atlaskit/layering": "^
|
|
62
|
-
"@atlaskit/link": "^
|
|
63
|
-
"@atlaskit/primitives": "^
|
|
64
|
-
"@atlaskit/section-message": "^
|
|
65
|
-
"@atlaskit/toggle": "^
|
|
49
|
+
"@atlaskit/badge": "^19.0.0",
|
|
50
|
+
"@atlaskit/button": "^24.0.0",
|
|
51
|
+
"@atlaskit/docs": "^12.0.0",
|
|
52
|
+
"@atlaskit/heading": "^6.0.0",
|
|
53
|
+
"@atlaskit/layering": "^4.0.0",
|
|
54
|
+
"@atlaskit/link": "^4.0.0",
|
|
55
|
+
"@atlaskit/primitives": "^20.0.0",
|
|
56
|
+
"@atlaskit/section-message": "^9.0.0",
|
|
57
|
+
"@atlaskit/toggle": "^17.0.0",
|
|
66
58
|
"@atlassian/react-compiler-gating": "workspace:^",
|
|
67
59
|
"@atlassian/ssr-tests": "workspace:^",
|
|
68
60
|
"@atlassian/structured-docs-types": "workspace:^",
|
package/types/package.json
CHANGED
|
@@ -6,12 +6,5 @@
|
|
|
6
6
|
"sideEffects": [
|
|
7
7
|
"**/*.compiled.css"
|
|
8
8
|
],
|
|
9
|
-
"types": "../dist/types/entry-points/types.d.ts"
|
|
10
|
-
"typesVersions": {
|
|
11
|
-
">=4.5 <5.9": {
|
|
12
|
-
"*": [
|
|
13
|
-
"../dist/types-ts4.5/entry-points/types.d.ts"
|
|
14
|
-
]
|
|
15
|
-
}
|
|
16
|
-
}
|
|
9
|
+
"types": "../dist/types/entry-points/types.d.ts"
|
|
17
10
|
}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @jsxRuntime classic
|
|
3
|
-
* @jsx jsx
|
|
4
|
-
*/
|
|
5
|
-
import { type ForwardRefExoticComponent, type MemoExoticComponent, type RefAttributes } from 'react';
|
|
6
|
-
import type { BlanketProps } from './types';
|
|
7
|
-
/**
|
|
8
|
-
* __Blanket__
|
|
9
|
-
*
|
|
10
|
-
* A Blanket provides the overlay layer for components such as a modal dialog or a tooltip
|
|
11
|
-
*
|
|
12
|
-
* - [Examples](https://atlaskit.atlassian.com/examples/design-system/blanket/basic-usage)
|
|
13
|
-
*/
|
|
14
|
-
declare const Blanket: MemoExoticComponent<ForwardRefExoticComponent<BlanketProps & RefAttributes<HTMLDivElement>>>;
|
|
15
|
-
export default Blanket;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export type { BlanketProps } from '../types';
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
import { type ReactNode } from 'react';
|
|
2
|
-
import type UIAnalyticsEvent from '@atlaskit/analytics-next/UIAnalyticsEvent';
|
|
3
|
-
export interface BlanketProps {
|
|
4
|
-
/**
|
|
5
|
-
* Whether mouse events can pass through the blanket. If `true`, `onBlanketClicked` will not be called.
|
|
6
|
-
*/
|
|
7
|
-
shouldAllowClickThrough?: boolean;
|
|
8
|
-
/**
|
|
9
|
-
* Sets whether the blanket has a tinted background color.
|
|
10
|
-
*/
|
|
11
|
-
isTinted?: boolean;
|
|
12
|
-
/**
|
|
13
|
-
* Handler function to be called when the blanket is clicked.
|
|
14
|
-
*/
|
|
15
|
-
onBlanketClicked?: (event: React.MouseEvent<HTMLDivElement>, analyticsEvent: UIAnalyticsEvent) => void;
|
|
16
|
-
/**
|
|
17
|
-
* Additional information to be included in the `context` of analytics events.
|
|
18
|
-
*/
|
|
19
|
-
analyticsContext?: Record<string, any>;
|
|
20
|
-
/**
|
|
21
|
-
* A `testId` prop is provided for specified elements,
|
|
22
|
-
* which is a unique string that appears as a data attribute `data-testid` in the rendered code,
|
|
23
|
-
* serving as a hook for automated tests.
|
|
24
|
-
*/
|
|
25
|
-
testId?: string;
|
|
26
|
-
/**
|
|
27
|
-
* The children to be rendered within the blanket.
|
|
28
|
-
*/
|
|
29
|
-
children?: ReactNode;
|
|
30
|
-
}
|