@atlaskit/badge 18.4.1 → 18.4.2
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 +7 -0
- package/badge.docs.tsx +53 -0
- package/dist/cjs/badge-new.js +1 -1
- package/dist/cjs/badge.js +1 -1
- package/dist/es2019/badge-new.js +1 -1
- package/dist/es2019/badge.js +1 -1
- package/dist/esm/badge-new.js +1 -1
- package/dist/esm/badge.js +1 -1
- package/package.json +8 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# @atlaskit/badge
|
|
2
2
|
|
|
3
|
+
## 18.4.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`22bf79dbdcdca`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/22bf79dbdcdca) -
|
|
8
|
+
Internal changes to remove unnecessary token fallbacks and imports from `@atlaskit/theme`
|
|
9
|
+
|
|
3
10
|
## 18.4.1
|
|
4
11
|
|
|
5
12
|
### Patch Changes
|
package/badge.docs.tsx
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
|
|
3
|
+
import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
|
|
4
|
+
|
|
5
|
+
const documentation: ComponentStructuredContentSource[] = [
|
|
6
|
+
{
|
|
7
|
+
name: 'Badge',
|
|
8
|
+
description:
|
|
9
|
+
'A badge is a visual indicator for numeric values such as tallies and scores, providing quick visual feedback.',
|
|
10
|
+
status: 'general-availability', // beta badge is feature-flagged
|
|
11
|
+
import: {
|
|
12
|
+
name: 'Badge',
|
|
13
|
+
package: '@atlaskit/badge',
|
|
14
|
+
type: 'default',
|
|
15
|
+
packagePath: path.resolve(__dirname),
|
|
16
|
+
packageJson: require('./package.json'),
|
|
17
|
+
},
|
|
18
|
+
usageGuidelines: [
|
|
19
|
+
'Use for displaying counts, scores, or status indicators for a single item or label',
|
|
20
|
+
'Use with one item/label only to avoid ambiguity',
|
|
21
|
+
'Keep badge content concise and meaningful',
|
|
22
|
+
'Use appropriate appearance variants for different contexts',
|
|
23
|
+
'Position badges near relevant content',
|
|
24
|
+
'Consider maximum value display limits',
|
|
25
|
+
'Add a tooltip when the badge has an icon or needs extra context.',
|
|
26
|
+
'Use Lozenge for non-numeric status; use Tag for labels',
|
|
27
|
+
],
|
|
28
|
+
contentGuidelines: [
|
|
29
|
+
'Use clear, concise numeric or text values',
|
|
30
|
+
'Ensure values are meaningful to users',
|
|
31
|
+
'Use consistent formatting across similar badges',
|
|
32
|
+
'Consider localization for number formatting (locale-aware numbers)',
|
|
33
|
+
],
|
|
34
|
+
accessibilityGuidelines: [
|
|
35
|
+
'Ensure badge content is announced by screen readers',
|
|
36
|
+
'Do not rely on color alone for positive/negative meaning',
|
|
37
|
+
'Use appropriate color contrast for text readability',
|
|
38
|
+
'Provide meaningful context for numeric values',
|
|
39
|
+
'Consider alternative text for non-numeric badges',
|
|
40
|
+
],
|
|
41
|
+
examples: [
|
|
42
|
+
{
|
|
43
|
+
name: 'Badge',
|
|
44
|
+
description: 'Badge example',
|
|
45
|
+
source: path.resolve(__dirname, './examples/ai/badge.tsx'),
|
|
46
|
+
},
|
|
47
|
+
],
|
|
48
|
+
keywords: ['badge', 'indicator', 'numeric', 'tally', 'score', 'count', 'status'],
|
|
49
|
+
categories: ['status-indicators'],
|
|
50
|
+
},
|
|
51
|
+
];
|
|
52
|
+
|
|
53
|
+
export default documentation;
|
package/dist/cjs/badge-new.js
CHANGED
package/dist/cjs/badge.js
CHANGED
package/dist/es2019/badge-new.js
CHANGED
package/dist/es2019/badge.js
CHANGED
package/dist/esm/badge-new.js
CHANGED
package/dist/esm/badge.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/badge",
|
|
3
|
-
"version": "18.4.
|
|
3
|
+
"version": "18.4.2",
|
|
4
4
|
"description": "A badge is a visual indicator for numeric values such as tallies and scores.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -43,10 +43,10 @@
|
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
46
|
-
"@atlaskit/primitives": "^18.
|
|
47
|
-
"@atlaskit/tokens": "^11.
|
|
46
|
+
"@atlaskit/primitives": "^18.1.0",
|
|
47
|
+
"@atlaskit/tokens": "^11.4.0",
|
|
48
48
|
"@babel/runtime": "^7.0.0",
|
|
49
|
-
"@compiled/react": "^0.
|
|
49
|
+
"@compiled/react": "^0.20.0"
|
|
50
50
|
},
|
|
51
51
|
"peerDependencies": {
|
|
52
52
|
"react": "^18.2.0"
|
|
@@ -55,13 +55,14 @@
|
|
|
55
55
|
"@af/accessibility-testing": "workspace:^",
|
|
56
56
|
"@af/integration-testing": "workspace:^",
|
|
57
57
|
"@af/visual-regression": "workspace:^",
|
|
58
|
-
"@atlaskit/docs": "^11.
|
|
58
|
+
"@atlaskit/docs": "^11.7.0",
|
|
59
59
|
"@atlaskit/link": "^3.3.0",
|
|
60
60
|
"@atlaskit/section-message": "^8.12.0",
|
|
61
|
-
"@atlaskit/theme": "^
|
|
61
|
+
"@atlaskit/theme": "^22.0.0",
|
|
62
62
|
"@atlassian/feature-flags-test-utils": "^1.0.0",
|
|
63
63
|
"@atlassian/ssr-tests": "workspace:*",
|
|
64
|
-
"@atlassian/
|
|
64
|
+
"@atlassian/structured-docs-types": "workspace:^",
|
|
65
|
+
"@atlassian/testing-library": "0.5.0",
|
|
65
66
|
"react-dom": "^18.2.0"
|
|
66
67
|
},
|
|
67
68
|
"techstack": {
|