@atlaskit/spotlight 0.10.9 → 0.10.10
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 +3 -3
- package/spotlight.docs.tsx +41 -0
package/CHANGELOG.md
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/spotlight",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.10",
|
|
4
4
|
"description": "A spotlight introduces users to points of interest, from focused messages to multi-step tours.",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"@atlaskit/css": "^0.19.0",
|
|
38
38
|
"@atlaskit/ds-lib": "^6.0.0",
|
|
39
39
|
"@atlaskit/heading": "^5.3.0",
|
|
40
|
-
"@atlaskit/icon": "^
|
|
40
|
+
"@atlaskit/icon": "^33.0.0",
|
|
41
41
|
"@atlaskit/image": "^3.0.0",
|
|
42
42
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
43
43
|
"@atlaskit/popper": "^7.1.0",
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"@af/accessibility-testing": "workspace:^",
|
|
56
56
|
"@af/integration-testing": "workspace:^",
|
|
57
57
|
"@af/visual-regression": "workspace:^",
|
|
58
|
-
"@atlaskit/dropdown-menu": "^16.
|
|
58
|
+
"@atlaskit/dropdown-menu": "^16.7.0",
|
|
59
59
|
"@atlaskit/ssr": "workspace:^",
|
|
60
60
|
"@atlassian/a11y-jest-testing": "^0.10.0",
|
|
61
61
|
"@testing-library/react": "^16.3.0",
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
|
|
3
|
+
import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
|
|
4
|
+
|
|
5
|
+
const documentation: ComponentStructuredContentSource[] = [
|
|
6
|
+
{
|
|
7
|
+
name: 'Spotlight',
|
|
8
|
+
description: 'A component for quick search and command execution.',
|
|
9
|
+
status: 'general-availability',
|
|
10
|
+
import: {
|
|
11
|
+
name: 'Spotlight',
|
|
12
|
+
package: '@atlaskit/spotlight',
|
|
13
|
+
type: 'named',
|
|
14
|
+
packagePath: path.resolve(__dirname),
|
|
15
|
+
packageJson: require('./package.json'),
|
|
16
|
+
},
|
|
17
|
+
usageGuidelines: [
|
|
18
|
+
'Use for quick search and commands',
|
|
19
|
+
'Provide clear search functionality',
|
|
20
|
+
'Consider keyboard shortcuts',
|
|
21
|
+
'Handle search results appropriately',
|
|
22
|
+
],
|
|
23
|
+
contentGuidelines: [
|
|
24
|
+
'Use clear, descriptive search labels',
|
|
25
|
+
'Provide helpful search suggestions',
|
|
26
|
+
'Use consistent command naming',
|
|
27
|
+
'Keep search results relevant',
|
|
28
|
+
],
|
|
29
|
+
accessibilityGuidelines: [
|
|
30
|
+
'Ensure proper keyboard navigation',
|
|
31
|
+
'Provide clear search functionality',
|
|
32
|
+
'Use appropriate ARIA attributes',
|
|
33
|
+
'Consider screen reader announcements',
|
|
34
|
+
],
|
|
35
|
+
examples: [],
|
|
36
|
+
keywords: ['spotlight', 'search', 'command', 'palette', 'quick'],
|
|
37
|
+
categories: ['navigation'],
|
|
38
|
+
},
|
|
39
|
+
];
|
|
40
|
+
|
|
41
|
+
export default documentation;
|