@atlaskit/select 21.8.1 → 21.8.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 +6 -0
- package/package.json +5 -4
- package/select.docs.tsx +51 -0
package/CHANGELOG.md
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/select",
|
|
3
|
-
"version": "21.8.
|
|
3
|
+
"version": "21.8.2",
|
|
4
4
|
"description": "Select allows users to make a single selection or multiple selections from a list of options.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"@atlaskit/analytics-next": "^11.1.0",
|
|
36
36
|
"@atlaskit/ds-lib": "^6.0.0",
|
|
37
|
-
"@atlaskit/icon": "^
|
|
37
|
+
"@atlaskit/icon": "^33.0.0",
|
|
38
38
|
"@atlaskit/layering": "^3.6.0",
|
|
39
39
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
40
40
|
"@atlaskit/primitives": "^18.0.0",
|
|
@@ -60,8 +60,8 @@
|
|
|
60
60
|
"@af/visual-regression": "workspace:^",
|
|
61
61
|
"@atlaskit/button": "^23.10.0",
|
|
62
62
|
"@atlaskit/checkbox": "^17.3.0",
|
|
63
|
-
"@atlaskit/docs": "^11.
|
|
64
|
-
"@atlaskit/drawer": "^
|
|
63
|
+
"@atlaskit/docs": "^11.7.0",
|
|
64
|
+
"@atlaskit/drawer": "^12.0.0",
|
|
65
65
|
"@atlaskit/form": "^15.4.0",
|
|
66
66
|
"@atlaskit/link": "^3.3.0",
|
|
67
67
|
"@atlaskit/logo": "^19.10.0",
|
|
@@ -70,6 +70,7 @@
|
|
|
70
70
|
"@atlaskit/section-message": "^8.12.0",
|
|
71
71
|
"@atlassian/feature-flags-test-utils": "^1.0.0",
|
|
72
72
|
"@atlassian/ssr-tests": "workspace:^",
|
|
73
|
+
"@atlassian/structured-docs-types": "workspace:^",
|
|
73
74
|
"@testing-library/react": "^16.3.0",
|
|
74
75
|
"@testing-library/user-event": "^14.4.3",
|
|
75
76
|
"ast-types": "^0.13.3",
|
package/select.docs.tsx
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
|
|
3
|
+
import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
|
|
4
|
+
|
|
5
|
+
const documentation: ComponentStructuredContentSource[] = [
|
|
6
|
+
{
|
|
7
|
+
name: 'Select',
|
|
8
|
+
description: 'A flexible select component for single and multi-selection.',
|
|
9
|
+
status: 'general-availability',
|
|
10
|
+
import: {
|
|
11
|
+
name: 'Select',
|
|
12
|
+
package: '@atlaskit/select',
|
|
13
|
+
type: 'default',
|
|
14
|
+
packagePath: path.resolve(__dirname),
|
|
15
|
+
packageJson: require('./package.json'),
|
|
16
|
+
},
|
|
17
|
+
usageGuidelines: [
|
|
18
|
+
'Use for choosing one or more from a list; common in forms and inline edit',
|
|
19
|
+
'Use a visible label for the field—do not use placeholder as the only label (placeholder disappears and is not accessible)',
|
|
20
|
+
'Use logical order (e.g. most selected first, numeric)',
|
|
21
|
+
'Do not overwhelm with too many options',
|
|
22
|
+
'Enable search for long option lists',
|
|
23
|
+
'Consider loading states for async data',
|
|
24
|
+
'Avoid alphabetical ordering (not localizable); use logical order for translatable option lists',
|
|
25
|
+
],
|
|
26
|
+
contentGuidelines: [
|
|
27
|
+
'Write clear, descriptive option labels',
|
|
28
|
+
'Use consistent terminology across options',
|
|
29
|
+
'Keep option text concise but meaningful',
|
|
30
|
+
'Group related options only when all items are groupable; use well-known categories or for disambiguation (e.g. Portland ME vs OR); no group of one',
|
|
31
|
+
],
|
|
32
|
+
accessibilityGuidelines: [
|
|
33
|
+
'Use labels and helper text for the field—do not use placeholder as label (disappears on focus, not accessible)',
|
|
34
|
+
'Clear control is removed from tab order; keyboard users clear selection via Delete',
|
|
35
|
+
'Provide clear labels for all selects',
|
|
36
|
+
'Ensure keyboard navigation with arrow keys',
|
|
37
|
+
'Support screen reader announcements',
|
|
38
|
+
],
|
|
39
|
+
examples: [
|
|
40
|
+
{
|
|
41
|
+
name: 'Default',
|
|
42
|
+
description: 'The default select appearance.',
|
|
43
|
+
source: path.resolve(__dirname, './examples/constellation/select-appearance-default.tsx'),
|
|
44
|
+
},
|
|
45
|
+
],
|
|
46
|
+
keywords: ['select', 'dropdown', 'form', 'input', 'options', 'choice', 'picker'],
|
|
47
|
+
categories: ['form'],
|
|
48
|
+
},
|
|
49
|
+
];
|
|
50
|
+
|
|
51
|
+
export default documentation;
|