@atlaskit/section-message 9.2.7 → 10.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.
- package/CHANGELOG.md +63 -0
- package/dist/cjs/section-message-action.js +3 -3
- package/dist/cjs/section-message.js +3 -3
- package/dist/es2019/entry-points/section-message-action.js +8 -1
- package/dist/es2019/entry-points/section-message.js +8 -1
- package/dist/es2019/section-message-action.js +2 -2
- package/dist/es2019/section-message.js +2 -2
- package/dist/esm/entry-points/section-message-action.js +8 -1
- package/dist/esm/entry-points/section-message.js +8 -1
- package/dist/esm/section-message-action.js +2 -2
- package/dist/esm/section-message.js +2 -2
- package/dist/types/entry-points/section-message-action.d.ts +6 -0
- package/dist/types/entry-points/section-message.d.ts +6 -0
- package/dist/types/types.d.ts +1 -1
- package/message/package.json +10 -0
- package/message-action/package.json +10 -0
- package/package.json +11 -33
- package/types/package.json +4 -4
- package/dist/cjs/entry-points/types.js +0 -1
- package/dist/es2019/entry-points/types.js +0 -0
- package/dist/esm/entry-points/types.js +0 -0
- package/dist/types/entry-points/types.d.ts +0 -1
- package/section-message.docs.tsx +0 -55
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,68 @@
|
|
|
1
1
|
# @atlaskit/section-message
|
|
2
2
|
|
|
3
|
+
## 10.1.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [`d82e6f76528ab`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d82e6f76528ab) -
|
|
8
|
+
Add direct subpath package exports as part of the linking-platform, search, media, and
|
|
9
|
+
design-system barrel-removal (de-barrel) migration.
|
|
10
|
+
|
|
11
|
+
These packages now expose their individual modules via explicit `package.json` `exports` subpaths
|
|
12
|
+
so that consumers can import directly from the leaf module (e.g. `@atlaskit/pkg/thing`) instead of
|
|
13
|
+
the package barrel/index. This adds new public entry points without changing or removing any
|
|
14
|
+
existing exports, so it is a backwards-compatible additive change.
|
|
15
|
+
|
|
16
|
+
No runtime behaviour changes; this is an API-surface (entry-point) addition to support
|
|
17
|
+
tree-shaking and to unblock removal of the barrel index files.
|
|
18
|
+
|
|
19
|
+
### Patch Changes
|
|
20
|
+
|
|
21
|
+
- Updated dependencies
|
|
22
|
+
|
|
23
|
+
## 10.0.0
|
|
24
|
+
|
|
25
|
+
### Major Changes
|
|
26
|
+
|
|
27
|
+
- [`48e7d03469b80`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/48e7d03469b80) -
|
|
28
|
+
Apply Volt entry-point and barrel-removal standards across these design-system packages. Public
|
|
29
|
+
`exports` now resolve **directly** to `./src/*` implementations instead of intermediate
|
|
30
|
+
`./src/entry-points/*` re-exports, root barrels and remaining entry-point shims are marked
|
|
31
|
+
deprecated in favour of per-export subpaths, and a few new subpaths are added
|
|
32
|
+
(`@atlaskit/badge/badge-new`, `@atlaskit/tile/tile-skeleton`, `@atlaskit/popper/main`,
|
|
33
|
+
`@atlaskit/section-message/message`, `@atlaskit/section-message/message-action`).
|
|
34
|
+
|
|
35
|
+
### Why this is breaking
|
|
36
|
+
|
|
37
|
+
Subpaths and the package root can now resolve to the **same module instance**. Consumers that
|
|
38
|
+
deep-imported `entry-points/*`, or `jest.mock()`'d a specific subpath may need updates.
|
|
39
|
+
`@atlaskit/image`'s root export now points at `./src/ui/image/index.tsx`.
|
|
40
|
+
`@atlaskit/checkbox/checkbox` now exports a named `Checkbox` from the implementation module
|
|
41
|
+
(default export retained for backwards compatibility).
|
|
42
|
+
|
|
43
|
+
### Migration
|
|
44
|
+
|
|
45
|
+
Prefer published subpaths over the package root:
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
import { Checkbox } from '@atlaskit/checkbox/checkbox';
|
|
49
|
+
import TextField from '@atlaskit/textfield/text-field';
|
|
50
|
+
import Popup from '@atlaskit/popup/popup';
|
|
51
|
+
import SectionMessage from '@atlaskit/section-message/message';
|
|
52
|
+
import EmptyState from '@atlaskit/empty-state/empty-state';
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
If you imported through internal entry-point modules, switch to the public subpath:
|
|
56
|
+
|
|
57
|
+
```diff
|
|
58
|
+
-import Checkbox from '@atlaskit/checkbox/entry-points/checkbox';
|
|
59
|
+
+import { Checkbox } from '@atlaskit/checkbox/checkbox';
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Patch Changes
|
|
63
|
+
|
|
64
|
+
- Updated dependencies
|
|
65
|
+
|
|
3
66
|
## 9.2.7
|
|
4
67
|
|
|
5
68
|
### Patch Changes
|
|
@@ -13,8 +13,8 @@ var React = _react;
|
|
|
13
13
|
var _runtime = require("@compiled/react/runtime");
|
|
14
14
|
var _standardButton = _interopRequireDefault(require("@atlaskit/button/standard-button"));
|
|
15
15
|
var _css = require("@atlaskit/css");
|
|
16
|
-
var _link = _interopRequireDefault(require("@atlaskit/link"));
|
|
17
|
-
var
|
|
16
|
+
var _link = _interopRequireDefault(require("@atlaskit/link/link"));
|
|
17
|
+
var _fg = require("@atlaskit/platform-feature-flags/fg");
|
|
18
18
|
var _compiled = require("@atlaskit/primitives/compiled");
|
|
19
19
|
function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
|
|
20
20
|
var styles = {
|
|
@@ -56,7 +56,7 @@ var SectionMessageAction = /*#__PURE__*/(0, _react.memo)( /*#__PURE__*/(0, _reac
|
|
|
56
56
|
return /*#__PURE__*/React.createElement(_compiled.Pressable, {
|
|
57
57
|
testId: testId,
|
|
58
58
|
onClick: onClick,
|
|
59
|
-
xcss: (0, _css.cx)(styles.common, styles.pressable, (0,
|
|
59
|
+
xcss: (0, _css.cx)(styles.common, styles.pressable, (0, _fg.fg)('platform-dst-shape-theme-default') && styles.pressableT26Shape),
|
|
60
60
|
ref: ref
|
|
61
61
|
}, children);
|
|
62
62
|
}
|
|
@@ -13,9 +13,9 @@ var React = _react;
|
|
|
13
13
|
var _runtime = require("@compiled/react/runtime");
|
|
14
14
|
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
|
|
15
15
|
var _new = require("@atlaskit/button/new");
|
|
16
|
-
var _heading = _interopRequireDefault(require("@atlaskit/heading"));
|
|
16
|
+
var _heading = _interopRequireDefault(require("@atlaskit/heading/heading"));
|
|
17
17
|
var _cross = _interopRequireDefault(require("@atlaskit/icon/core/cross"));
|
|
18
|
-
var
|
|
18
|
+
var _fg = require("@atlaskit/platform-feature-flags/fg");
|
|
19
19
|
var _compiled = require("@atlaskit/primitives/compiled");
|
|
20
20
|
var _appearanceIcon = require("./internal/appearance-icon");
|
|
21
21
|
function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
|
|
@@ -74,7 +74,7 @@ var SectionMessage = /*#__PURE__*/(0, _react.forwardRef)(function SectionMessage
|
|
|
74
74
|
return isDismissible && dismissed ? null : /*#__PURE__*/React.createElement("section", {
|
|
75
75
|
"data-testid": testId,
|
|
76
76
|
ref: ref,
|
|
77
|
-
className: (0, _runtime.ax)([sectionMessageStyles.container, (0,
|
|
77
|
+
className: (0, _runtime.ax)([sectionMessageStyles.container, (0, _fg.fg)('platform-dst-shape-theme-default') && sectionMessageStyles.containerT26Shape, appearanceStyles[appearance]])
|
|
78
78
|
}, /*#__PURE__*/React.createElement(_compiled.Inline, {
|
|
79
79
|
space: "space.200",
|
|
80
80
|
alignBlock: "stretch"
|
|
@@ -1 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
|
|
2
|
+
/**
|
|
3
|
+
* @deprecated Use `import SectionMessageAction from '@atlaskit/section-message/message-action'` instead.
|
|
4
|
+
*/
|
|
5
|
+
export { default } from '../section-message-action';
|
|
6
|
+
/**
|
|
7
|
+
* @deprecated Use `import type { SectionMessageActionProps } from '@atlaskit/section-message/types'` instead.
|
|
8
|
+
*/
|
|
@@ -1 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
|
|
2
|
+
/**
|
|
3
|
+
* @deprecated Use `import SectionMessage from '@atlaskit/section-message/message'` instead.
|
|
4
|
+
*/
|
|
5
|
+
export { default } from '../section-message';
|
|
6
|
+
/**
|
|
7
|
+
* @deprecated Use `import type { SectionMessageProps } from '@atlaskit/section-message/types'` instead.
|
|
8
|
+
*/
|
|
@@ -5,8 +5,8 @@ import { ax, ix } from "@compiled/react/runtime";
|
|
|
5
5
|
import { forwardRef, Fragment, memo } from 'react';
|
|
6
6
|
import Button from '@atlaskit/button/standard-button';
|
|
7
7
|
import { cx } from '@atlaskit/css';
|
|
8
|
-
import Link from '@atlaskit/link';
|
|
9
|
-
import { fg } from '@atlaskit/platform-feature-flags';
|
|
8
|
+
import Link from '@atlaskit/link/link';
|
|
9
|
+
import { fg } from '@atlaskit/platform-feature-flags/fg';
|
|
10
10
|
import { Box, Pressable } from '@atlaskit/primitives/compiled';
|
|
11
11
|
const styles = {
|
|
12
12
|
common: "_11c8fhey",
|
|
@@ -4,9 +4,9 @@ import * as React from 'react';
|
|
|
4
4
|
import { ax, ix } from "@compiled/react/runtime";
|
|
5
5
|
import { Children, forwardRef, Fragment, useCallback, useState } from 'react';
|
|
6
6
|
import { IconButton } from '@atlaskit/button/new';
|
|
7
|
-
import Heading from '@atlaskit/heading';
|
|
7
|
+
import Heading from '@atlaskit/heading/heading';
|
|
8
8
|
import CrossIcon from '@atlaskit/icon/core/cross';
|
|
9
|
-
import { fg } from '@atlaskit/platform-feature-flags';
|
|
9
|
+
import { fg } from '@atlaskit/platform-feature-flags/fg';
|
|
10
10
|
import { Inline, Stack } from '@atlaskit/primitives/compiled';
|
|
11
11
|
import { getAppearanceIconStyles } from './internal/appearance-icon';
|
|
12
12
|
const sectionMessageStyles = {
|
|
@@ -1 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
|
|
2
|
+
/**
|
|
3
|
+
* @deprecated Use `import SectionMessageAction from '@atlaskit/section-message/message-action'` instead.
|
|
4
|
+
*/
|
|
5
|
+
export { default } from '../section-message-action';
|
|
6
|
+
/**
|
|
7
|
+
* @deprecated Use `import type { SectionMessageActionProps } from '@atlaskit/section-message/types'` instead.
|
|
8
|
+
*/
|
|
@@ -1 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
|
|
2
|
+
/**
|
|
3
|
+
* @deprecated Use `import SectionMessage from '@atlaskit/section-message/message'` instead.
|
|
4
|
+
*/
|
|
5
|
+
export { default } from '../section-message';
|
|
6
|
+
/**
|
|
7
|
+
* @deprecated Use `import type { SectionMessageProps } from '@atlaskit/section-message/types'` instead.
|
|
8
|
+
*/
|
|
@@ -5,8 +5,8 @@ import { ax, ix } from "@compiled/react/runtime";
|
|
|
5
5
|
import { forwardRef, Fragment, memo } from 'react';
|
|
6
6
|
import Button from '@atlaskit/button/standard-button';
|
|
7
7
|
import { cx } from '@atlaskit/css';
|
|
8
|
-
import Link from '@atlaskit/link';
|
|
9
|
-
import { fg } from '@atlaskit/platform-feature-flags';
|
|
8
|
+
import Link from '@atlaskit/link/link';
|
|
9
|
+
import { fg } from '@atlaskit/platform-feature-flags/fg';
|
|
10
10
|
import { Box, Pressable } from '@atlaskit/primitives/compiled';
|
|
11
11
|
var styles = {
|
|
12
12
|
common: "_11c8fhey",
|
|
@@ -5,9 +5,9 @@ import * as React from 'react';
|
|
|
5
5
|
import { ax, ix } from "@compiled/react/runtime";
|
|
6
6
|
import { Children, forwardRef, Fragment, useCallback, useState } from 'react';
|
|
7
7
|
import { IconButton } from '@atlaskit/button/new';
|
|
8
|
-
import Heading from '@atlaskit/heading';
|
|
8
|
+
import Heading from '@atlaskit/heading/heading';
|
|
9
9
|
import CrossIcon from '@atlaskit/icon/core/cross';
|
|
10
|
-
import { fg } from '@atlaskit/platform-feature-flags';
|
|
10
|
+
import { fg } from '@atlaskit/platform-feature-flags/fg';
|
|
11
11
|
import { Inline, Stack } from '@atlaskit/primitives/compiled';
|
|
12
12
|
import { getAppearanceIconStyles } from './internal/appearance-icon';
|
|
13
13
|
var sectionMessageStyles = {
|
|
@@ -1,2 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @deprecated Use `import SectionMessageAction from '@atlaskit/section-message/message-action'` instead.
|
|
3
|
+
*/
|
|
1
4
|
export { default } from '../section-message-action';
|
|
5
|
+
/**
|
|
6
|
+
* @deprecated Use `import type { SectionMessageActionProps } from '@atlaskit/section-message/types'` instead.
|
|
7
|
+
*/
|
|
2
8
|
export type { SectionMessageActionProps } from '../types';
|
|
@@ -1,2 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @deprecated Use `import SectionMessage from '@atlaskit/section-message/message'` instead.
|
|
3
|
+
*/
|
|
1
4
|
export { default } from '../section-message';
|
|
5
|
+
/**
|
|
6
|
+
* @deprecated Use `import type { SectionMessageProps } from '@atlaskit/section-message/types'` instead.
|
|
7
|
+
*/
|
|
2
8
|
export type { SectionMessageProps } from '../types';
|
package/dist/types/types.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ReactElement } from 'react';
|
|
2
|
-
import type
|
|
2
|
+
import type UIAnalyticsEvent from '@atlaskit/analytics-next/UIAnalyticsEvent';
|
|
3
3
|
/**
|
|
4
4
|
* Appearance determines the icon and background color pairing indicating the message type
|
|
5
5
|
*/
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@atlaskit/section-message/message",
|
|
3
|
+
"main": "../dist/cjs/section-message.js",
|
|
4
|
+
"module": "../dist/esm/section-message.js",
|
|
5
|
+
"module:es2019": "../dist/es2019/section-message.js",
|
|
6
|
+
"sideEffects": [
|
|
7
|
+
"**/*.compiled.css"
|
|
8
|
+
],
|
|
9
|
+
"types": "../dist/types/section-message.d.ts"
|
|
10
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@atlaskit/section-message/message-action",
|
|
3
|
+
"main": "../dist/cjs/section-message-action.js",
|
|
4
|
+
"module": "../dist/esm/section-message-action.js",
|
|
5
|
+
"module:es2019": "../dist/es2019/section-message-action.js",
|
|
6
|
+
"sideEffects": [
|
|
7
|
+
"**/*.compiled.css"
|
|
8
|
+
],
|
|
9
|
+
"types": "../dist/types/section-message-action.d.ts"
|
|
10
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/section-message",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "10.1.0",
|
|
4
4
|
"description": "A section message is used to alert users to a particular section of the screen.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -31,15 +31,15 @@
|
|
|
31
31
|
}
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@atlaskit/button": "^25.
|
|
34
|
+
"@atlaskit/button": "^25.2.0",
|
|
35
35
|
"@atlaskit/css": "^1.0.0",
|
|
36
|
-
"@atlaskit/heading": "^7.
|
|
37
|
-
"@atlaskit/icon": "^37.
|
|
38
|
-
"@atlaskit/link": "^5.
|
|
36
|
+
"@atlaskit/heading": "^7.1.0",
|
|
37
|
+
"@atlaskit/icon": "^37.5.0",
|
|
38
|
+
"@atlaskit/link": "^5.1.0",
|
|
39
39
|
"@atlaskit/platform-feature-flags": "^2.1.0",
|
|
40
|
-
"@atlaskit/primitives": "^22.
|
|
40
|
+
"@atlaskit/primitives": "^22.4.0",
|
|
41
41
|
"@atlaskit/react-compiler-gating": "^0.2.0",
|
|
42
|
-
"@atlaskit/tokens": "^16.
|
|
42
|
+
"@atlaskit/tokens": "^16.8.0",
|
|
43
43
|
"@babel/runtime": "^7.0.0"
|
|
44
44
|
},
|
|
45
45
|
"peerDependencies": {
|
|
@@ -50,11 +50,11 @@
|
|
|
50
50
|
"@af/integration-testing": "workspace:^",
|
|
51
51
|
"@af/visual-regression": "workspace:^",
|
|
52
52
|
"@atlaskit/analytics-next": "^12.3.0",
|
|
53
|
-
"@atlaskit/code": "^
|
|
54
|
-
"@atlaskit/docs": "^12.
|
|
53
|
+
"@atlaskit/code": "^19.1.0",
|
|
54
|
+
"@atlaskit/docs": "^12.2.0",
|
|
55
55
|
"@atlaskit/ds-lib": "^8.0.0",
|
|
56
|
-
"@atlaskit/form": "^
|
|
57
|
-
"@atlaskit/range": "^
|
|
56
|
+
"@atlaskit/form": "^17.1.0",
|
|
57
|
+
"@atlaskit/range": "^12.1.0",
|
|
58
58
|
"@atlassian/ssr-tests": "workspace:^",
|
|
59
59
|
"@atlassian/structured-docs-types": "workspace:^",
|
|
60
60
|
"@testing-library/react": "^16.3.0",
|
|
@@ -62,28 +62,6 @@
|
|
|
62
62
|
"react": "^18.2.0",
|
|
63
63
|
"react-dom": "^18.2.0"
|
|
64
64
|
},
|
|
65
|
-
"techstack": {
|
|
66
|
-
"@atlassian/frontend": {
|
|
67
|
-
"import-structure": "atlassian-conventions"
|
|
68
|
-
},
|
|
69
|
-
"@repo/internal": {
|
|
70
|
-
"design-system": "v1",
|
|
71
|
-
"dom-events": "use-bind-event-listener",
|
|
72
|
-
"ui-components": [
|
|
73
|
-
"primitives",
|
|
74
|
-
"lite-mode"
|
|
75
|
-
],
|
|
76
|
-
"analytics": "analytics-next",
|
|
77
|
-
"styling": [
|
|
78
|
-
"emotion"
|
|
79
|
-
],
|
|
80
|
-
"design-tokens": [
|
|
81
|
-
"color",
|
|
82
|
-
"spacing"
|
|
83
|
-
],
|
|
84
|
-
"deprecation": "no-deprecated-imports"
|
|
85
|
-
}
|
|
86
|
-
},
|
|
87
65
|
"platform-feature-flags": {
|
|
88
66
|
"platform-dst-shape-theme-default": {
|
|
89
67
|
"type": "boolean"
|
package/types/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/section-message/types",
|
|
3
|
-
"main": "../dist/cjs/
|
|
4
|
-
"module": "../dist/esm/
|
|
5
|
-
"module:es2019": "../dist/es2019/
|
|
3
|
+
"main": "../dist/cjs/types.js",
|
|
4
|
+
"module": "../dist/esm/types.js",
|
|
5
|
+
"module:es2019": "../dist/es2019/types.js",
|
|
6
6
|
"sideEffects": [
|
|
7
7
|
"**/*.compiled.css"
|
|
8
8
|
],
|
|
9
|
-
"types": "../dist/types/
|
|
9
|
+
"types": "../dist/types/types.d.ts"
|
|
10
10
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
File without changes
|
|
File without changes
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export type { Appearance, SectionMessageProps, SectionMessageActionProps } from '../types';
|
package/section-message.docs.tsx
DELETED
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
import path from 'path';
|
|
2
|
-
|
|
3
|
-
import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
|
|
4
|
-
|
|
5
|
-
const documentation: StructuredContentSource = {
|
|
6
|
-
components: [
|
|
7
|
-
{
|
|
8
|
-
name: 'SectionMessage',
|
|
9
|
-
description: 'A component for section-level messages.',
|
|
10
|
-
status: 'general-availability',
|
|
11
|
-
designSource: {
|
|
12
|
-
figmaUrl: 'https://go.atlassian.com/figma-library-ads-82088-101069',
|
|
13
|
-
},
|
|
14
|
-
import: {
|
|
15
|
-
name: 'SectionMessage',
|
|
16
|
-
package: '@atlaskit/section-message/section-message',
|
|
17
|
-
type: 'default',
|
|
18
|
-
packagePath: path.resolve(__dirname),
|
|
19
|
-
packageJson: require('./package.json'),
|
|
20
|
-
},
|
|
21
|
-
usageGuidelines: [
|
|
22
|
-
'Use for section-level important info that persists until action or resolution',
|
|
23
|
-
'Use when: destructive consequences, action needed to proceed, connectivity or auth issues',
|
|
24
|
-
'Anatomy: icon+color, title (optional), description, actions (optional)',
|
|
25
|
-
'Use Banner for site-wide; Flag after an event; Inline message for smaller context',
|
|
26
|
-
],
|
|
27
|
-
contentGuidelines: [
|
|
28
|
-
'Title: state the issue or reason',
|
|
29
|
-
'Description: clear, concise, empathetic; use active verbs',
|
|
30
|
-
'Avoid blame—use "we\'re having trouble" not "you\'re having issues"',
|
|
31
|
-
'Provide clear next steps when needed',
|
|
32
|
-
],
|
|
33
|
-
accessibilityGuidelines: [
|
|
34
|
-
'Do not rely on color alone for severity',
|
|
35
|
-
'Avoid dead ends—always indicate how to proceed',
|
|
36
|
-
'Use descriptive link text that describes the destination',
|
|
37
|
-
'Ensure section message content is announced by screen readers',
|
|
38
|
-
'Use appropriate color contrast for text readability',
|
|
39
|
-
'Provide clear, actionable messaging',
|
|
40
|
-
'Consider keyboard navigation for interactive section messages',
|
|
41
|
-
],
|
|
42
|
-
examples: [
|
|
43
|
-
{
|
|
44
|
-
name: 'Section Message',
|
|
45
|
-
description: 'Section Message example',
|
|
46
|
-
source: path.resolve(__dirname, './examples/ai/section-message.tsx'),
|
|
47
|
-
},
|
|
48
|
-
],
|
|
49
|
-
keywords: ['section', 'message', 'alert', 'notification', 'contextual', 'information'],
|
|
50
|
-
categories: ['feedback'],
|
|
51
|
-
},
|
|
52
|
-
],
|
|
53
|
-
};
|
|
54
|
-
|
|
55
|
-
export default documentation;
|