@atlaskit/quick-search 10.0.1 → 10.0.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 +8 -0
- package/README.md +1 -1
- package/docs/0-intro.tsx +14 -4
- package/package.json +3 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# @atlaskit/quick-search
|
|
2
2
|
|
|
3
|
+
## 10.0.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#114055](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/114055)
|
|
8
|
+
[`5011ea90ffebe`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/5011ea90ffebe) -
|
|
9
|
+
Add deprecation notice
|
|
10
|
+
|
|
3
11
|
## 10.0.1
|
|
4
12
|
|
|
5
13
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
This package has been deprecated. Please use the
|
|
1
|
+
This package has been deprecated. Please use the `@atlassian/search-dialog` package instead.
|
package/docs/0-intro.tsx
CHANGED
|
@@ -1,11 +1,21 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { md, Example, Props, code, AtlassianInternalWarning } from '@atlaskit/docs';
|
|
3
|
+
import SectionMessage from '@atlaskit/section-message';
|
|
4
|
+
import { Code } from '@atlaskit/code';
|
|
3
5
|
|
|
4
6
|
export default md`
|
|
7
|
+
${(
|
|
8
|
+
<SectionMessage appearance="error" title="@atlaskit/quick-search is deprecated">
|
|
9
|
+
This package has been deprecated. Please use <Code>@atlassian/search-dialog</Code> instead.
|
|
10
|
+
</SectionMessage>
|
|
11
|
+
)}
|
|
12
|
+
|
|
13
|
+
<br />
|
|
14
|
+
|
|
5
15
|
${(<AtlassianInternalWarning />)}
|
|
6
16
|
|
|
7
17
|
This is a barebones quick-search component that can render different types of search results.
|
|
8
|
-
|
|
18
|
+
|
|
9
19
|
## Usage
|
|
10
20
|
${code`import { QuickSearch, ObjectResult, ContainerResult, ResultItemGroup } from '@atlaskit/quick-search';
|
|
11
21
|
|
|
@@ -19,11 +29,11 @@ export default md`
|
|
|
19
29
|
>
|
|
20
30
|
// render search results:
|
|
21
31
|
<ResultItemGroup title="Issues">
|
|
22
|
-
<ObjectResult name="Fix this and that" objectKey="JRA-123" />
|
|
23
|
-
<ObjectResult name="More stuff" objectKey="JRA-124" />
|
|
32
|
+
<ObjectResult name="Fix this and that" objectKey="JRA-123" />
|
|
33
|
+
<ObjectResult name="More stuff" objectKey="JRA-124" />
|
|
24
34
|
</ResultItemGroup>
|
|
25
35
|
<ResultItemGroup title="Spaces">
|
|
26
|
-
<ContainerResult name="Search and Smarts" />
|
|
36
|
+
<ContainerResult name="Search and Smarts" />
|
|
27
37
|
</ResultItemGroup>
|
|
28
38
|
</QuickSearch>
|
|
29
39
|
);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/quick-search",
|
|
3
|
-
"version": "10.0.
|
|
3
|
+
"version": "10.0.2",
|
|
4
4
|
"description": "A quick-search component",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -24,7 +24,8 @@
|
|
|
24
24
|
"atlassian": {
|
|
25
25
|
"team": "Search Platform: Search Experience",
|
|
26
26
|
"website": {
|
|
27
|
-
"name": "Quick Search"
|
|
27
|
+
"name": "Quick Search",
|
|
28
|
+
"deprecated": "This package is deprecated, please use @atlassian/search-dialog."
|
|
28
29
|
}
|
|
29
30
|
},
|
|
30
31
|
"dependencies": {
|