@atlaskit/quick-search 8.1.10 → 8.1.11
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 +261 -114
- package/compass.yml +0 -1
- package/dist/cjs/components/ResultItem/styled.js +69 -13
- package/dist/cjs/components/Search/Search.js +8 -4
- package/dist/cjs/components/Search/styled.js +59 -10
- package/dist/es2019/components/ResultItem/styled.js +62 -47
- package/dist/es2019/components/Search/Search.js +8 -5
- package/dist/es2019/components/Search/styled.js +85 -66
- package/dist/esm/components/ResultItem/styled.js +68 -13
- package/dist/esm/components/Search/Search.js +8 -3
- package/dist/esm/components/Search/styled.js +60 -10
- package/dist/types/components/QuickSearch.d.ts +3 -3
- package/dist/types/components/Results/ContainerResult.d.ts +1 -1
- package/dist/types/components/Results/ObjectResult.d.ts +1 -1
- package/dist/types/components/Results/PersonResult.d.ts +1 -1
- package/dist/types/components/Results/ResultBase.d.ts +2 -2
- package/dist/types/components/Results/types.d.ts +1 -1
- package/dist/types/components/context.d.ts +3 -3
- package/dist/types/components/decorateWithAnalyticsData.d.ts +1 -1
- package/dist/types-ts4.5/components/QuickSearch.d.ts +3 -3
- package/dist/types-ts4.5/components/Results/ContainerResult.d.ts +1 -1
- package/dist/types-ts4.5/components/Results/ObjectResult.d.ts +1 -1
- package/dist/types-ts4.5/components/Results/PersonResult.d.ts +1 -1
- package/dist/types-ts4.5/components/Results/ResultBase.d.ts +2 -2
- package/dist/types-ts4.5/components/Results/types.d.ts +1 -1
- package/dist/types-ts4.5/components/context.d.ts +3 -3
- package/dist/types-ts4.5/components/decorateWithAnalyticsData.d.ts +1 -1
- package/docs/0-intro.tsx +8 -18
- package/package.json +55 -57
- package/report.api.md +152 -156
package/report.api.md
CHANGED
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
## API Report File for "@atlaskit/quick-search"
|
|
4
4
|
|
|
5
|
-
> Do not edit this file. This report is auto-generated using
|
|
5
|
+
> Do not edit this file. This report is auto-generated using
|
|
6
|
+
> [API Extractor](https://api-extractor.com/).
|
|
6
7
|
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
7
8
|
|
|
8
9
|
### Table of contents
|
|
@@ -21,26 +22,26 @@ import { ReactNode } from 'react';
|
|
|
21
22
|
|
|
22
23
|
// @public (undocumented)
|
|
23
24
|
export class AkNavigationItem extends React_2.PureComponent<Props_2> {
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
25
|
+
// (undocumented)
|
|
26
|
+
static defaultProps: Partial<Props_2>;
|
|
27
|
+
// (undocumented)
|
|
28
|
+
render(): JSX.Element;
|
|
28
29
|
}
|
|
29
30
|
|
|
30
31
|
// @public (undocumented)
|
|
31
32
|
export class AkSearch extends React_2.PureComponent<Props_4> {
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
33
|
+
// (undocumented)
|
|
34
|
+
static defaultProps: Partial<Props_4>;
|
|
35
|
+
// (undocumented)
|
|
36
|
+
inputRef?: React_2.Ref<any>;
|
|
37
|
+
// (undocumented)
|
|
38
|
+
onInputKeyDown: (event: React_2.KeyboardEvent<HTMLInputElement>) => void;
|
|
39
|
+
// (undocumented)
|
|
40
|
+
render(): JSX.Element;
|
|
41
|
+
// (undocumented)
|
|
42
|
+
renderInputControls: () => JSX.Element | null;
|
|
43
|
+
// (undocumented)
|
|
44
|
+
setInputRef: (ref: React_2.Ref<any>) => void;
|
|
44
45
|
}
|
|
45
46
|
|
|
46
47
|
// @public (undocumented)
|
|
@@ -48,40 +49,40 @@ type AnalyticsData = Object;
|
|
|
48
49
|
|
|
49
50
|
// @public (undocumented)
|
|
50
51
|
export type CancelableEvent =
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
52
|
+
| KeyboardEvent
|
|
53
|
+
| MouseEvent
|
|
54
|
+
| React.KeyboardEvent<HTMLInputElement>
|
|
55
|
+
| React.MouseEvent<HTMLElement>;
|
|
55
56
|
|
|
56
57
|
// @public (undocumented)
|
|
57
58
|
type CommonResultProps = {
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
59
|
+
resultId: number | string;
|
|
60
|
+
type?: string;
|
|
61
|
+
avatarUrl?: string;
|
|
62
|
+
avatar?: ReactNode;
|
|
63
|
+
elemAfter?: ReactNode;
|
|
64
|
+
selectedIcon?: ReactNode;
|
|
65
|
+
href?: string;
|
|
66
|
+
target?: string;
|
|
67
|
+
isCompact?: boolean;
|
|
68
|
+
onClick?: (resultData: ResultData) => void;
|
|
69
|
+
analyticsData?: (() => AnalyticsData) | AnalyticsData;
|
|
69
70
|
};
|
|
70
71
|
|
|
71
72
|
// @public
|
|
72
73
|
export class ContainerResult extends React_2.PureComponent<ContainerResultProps> {
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
74
|
+
// (undocumented)
|
|
75
|
+
getAvatar: () => {};
|
|
76
|
+
// (undocumented)
|
|
77
|
+
render(): JSX.Element;
|
|
77
78
|
}
|
|
78
79
|
|
|
79
80
|
// @public (undocumented)
|
|
80
81
|
export type ContainerResultProps = CommonResultProps & {
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
82
|
+
name: React_2.ReactNode;
|
|
83
|
+
caption?: string;
|
|
84
|
+
isPrivate?: boolean;
|
|
85
|
+
subText?: React_2.ReactNode;
|
|
85
86
|
};
|
|
86
87
|
|
|
87
88
|
// @public
|
|
@@ -91,110 +92,107 @@ export { _default as QuickSearch };
|
|
|
91
92
|
|
|
92
93
|
// @public (undocumented)
|
|
93
94
|
type DefaultProps = {
|
|
94
|
-
|
|
95
|
+
context: ResultContextType;
|
|
95
96
|
};
|
|
96
97
|
|
|
97
98
|
// @public
|
|
98
99
|
export class ObjectResult extends React_2.PureComponent<ObjectResultProps> {
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
100
|
+
// (undocumented)
|
|
101
|
+
getAvatar: () => {};
|
|
102
|
+
// (undocumented)
|
|
103
|
+
getSubtext(): null | undefined | {};
|
|
104
|
+
// (undocumented)
|
|
105
|
+
render(): JSX.Element;
|
|
105
106
|
}
|
|
106
107
|
|
|
107
108
|
// @public (undocumented)
|
|
108
109
|
export type ObjectResultProps = CommonResultProps & {
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
110
|
+
name: React_2.ReactNode;
|
|
111
|
+
caption?: string;
|
|
112
|
+
containerName?: React_2.ReactNode;
|
|
113
|
+
isPrivate?: boolean;
|
|
114
|
+
objectKey?: React_2.ReactNode;
|
|
114
115
|
};
|
|
115
116
|
|
|
116
117
|
// @public (undocumented)
|
|
117
118
|
export class PersonResult extends React_2.PureComponent<PersonResultProps> {
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
119
|
+
// (undocumented)
|
|
120
|
+
static defaultProps: Partial<PersonResultProps>;
|
|
121
|
+
// (undocumented)
|
|
122
|
+
getAvatar: () => {};
|
|
123
|
+
// (undocumented)
|
|
124
|
+
getMention: () => string | undefined;
|
|
125
|
+
// (undocumented)
|
|
126
|
+
render(): JSX.Element;
|
|
126
127
|
}
|
|
127
128
|
|
|
128
129
|
// @public (undocumented)
|
|
129
130
|
export type PersonResultProps = CommonResultProps & {
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
131
|
+
name: React_2.ReactNode;
|
|
132
|
+
mentionName?: string;
|
|
133
|
+
mentionPrefix?: string;
|
|
134
|
+
presenceMessage?: React_2.ReactNode;
|
|
135
|
+
presenceState?: 'busy' | 'offline' | 'online' | null;
|
|
135
136
|
};
|
|
136
137
|
|
|
137
138
|
// @public (undocumented)
|
|
138
139
|
type Props = {
|
|
139
|
-
|
|
140
|
-
|
|
140
|
+
title: React_2.ReactNode;
|
|
141
|
+
children?: React_2.ReactNode;
|
|
141
142
|
};
|
|
142
143
|
|
|
143
144
|
// @public (undocumented)
|
|
144
145
|
type Props_2 = {
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
146
|
+
caption?: string;
|
|
147
|
+
href?: string;
|
|
148
|
+
target?: string;
|
|
149
|
+
icon?: React_2.ReactNode;
|
|
150
|
+
isCompact?: boolean;
|
|
151
|
+
isSelected?: boolean;
|
|
152
|
+
isMouseSelected?: boolean;
|
|
153
|
+
onClick?(e: MouseEvent): void;
|
|
154
|
+
onMouseEnter?: (e: MouseEvent) => void;
|
|
155
|
+
onMouseLeave?: (e: MouseEvent) => void;
|
|
156
|
+
subText?: React_2.ReactNode;
|
|
157
|
+
text?: React_2.ReactNode;
|
|
158
|
+
textAfter?: React_2.ReactNode;
|
|
159
|
+
selectedIcon?: React_2.ReactNode;
|
|
160
|
+
linkComponent?: React_2.ComponentType;
|
|
160
161
|
};
|
|
161
162
|
|
|
162
163
|
// @public (undocumented)
|
|
163
164
|
type Props_3 = {
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
linkComponent?: React_2.ComponentType<any>;
|
|
179
|
-
inputControls?: React_2.ReactNode;
|
|
180
|
-
autocompleteText?: string;
|
|
165
|
+
children: React_2.ReactNode;
|
|
166
|
+
isLoading?: boolean;
|
|
167
|
+
onSearchBlur?: (event: React_2.FocusEvent<HTMLInputElement>) => void;
|
|
168
|
+
onSearchInput?: (event: React_2.FormEvent<HTMLInputElement>, isAutocompleted?: boolean) => void;
|
|
169
|
+
onSearchKeyDown?: (event: React_2.KeyboardEvent<HTMLInputElement>) => void;
|
|
170
|
+
onSearchSubmit?: (event: React_2.KeyboardEvent<HTMLInputElement>) => void;
|
|
171
|
+
placeholder?: string;
|
|
172
|
+
value?: string;
|
|
173
|
+
selectedResultId?: SelectedResultId;
|
|
174
|
+
onSelectedResultIdChanged?: (id: SelectedResultId) => void;
|
|
175
|
+
firePrivateAnalyticsEvent?: (eventName: string, eventData: Object) => void;
|
|
176
|
+
linkComponent?: React_2.ComponentType<any>;
|
|
177
|
+
inputControls?: React_2.ReactNode;
|
|
178
|
+
autocompleteText?: string;
|
|
181
179
|
};
|
|
182
180
|
|
|
183
181
|
// @public (undocumented)
|
|
184
182
|
type Props_4 = {
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
183
|
+
children?: React_2.ReactNode;
|
|
184
|
+
inputControls?: React_2.ReactNode;
|
|
185
|
+
isLoading?: boolean;
|
|
186
|
+
onBlur?: (event: React_2.FocusEvent<HTMLInputElement>) => void;
|
|
187
|
+
onInput?: (event: React_2.FormEvent<HTMLInputElement>) => void;
|
|
188
|
+
onKeyDown?: (event: React_2.KeyboardEvent<HTMLInputElement>) => void;
|
|
189
|
+
placeholder?: string;
|
|
190
|
+
value?: string;
|
|
191
|
+
autocompleteText?: string;
|
|
194
192
|
};
|
|
195
193
|
|
|
196
194
|
declare namespace quickSearchResultTypes {
|
|
197
|
-
|
|
195
|
+
export { ContainerResult, ObjectResult, PersonResult, ResultBase };
|
|
198
196
|
}
|
|
199
197
|
export { quickSearchResultTypes };
|
|
200
198
|
|
|
@@ -202,61 +200,59 @@ export { quickSearchResultTypes };
|
|
|
202
200
|
export const ResultBase: (props: ResultBaseProps) => JSX.Element;
|
|
203
201
|
|
|
204
202
|
// @public (undocumented)
|
|
205
|
-
class ResultBase_2 extends React_2.PureComponent<
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
isMouseSelected: boolean;
|
|
231
|
-
};
|
|
203
|
+
class ResultBase_2 extends React_2.PureComponent<DefaultProps & ResultBaseProps> {
|
|
204
|
+
// (undocumented)
|
|
205
|
+
componentDidMount(): void;
|
|
206
|
+
// (undocumented)
|
|
207
|
+
componentDidUpdate(): void;
|
|
208
|
+
// (undocumented)
|
|
209
|
+
componentWillUnmount(): void;
|
|
210
|
+
// (undocumented)
|
|
211
|
+
static defaultProps: Partial<ResultBaseProps>;
|
|
212
|
+
// (undocumented)
|
|
213
|
+
getAnalyticsData(): AnalyticsData;
|
|
214
|
+
// (undocumented)
|
|
215
|
+
handleClick: (e: MouseEvent) => void;
|
|
216
|
+
// (undocumented)
|
|
217
|
+
handleMouseEnter: (event: MouseEvent) => void;
|
|
218
|
+
// (undocumented)
|
|
219
|
+
handleMouseLeave: () => void;
|
|
220
|
+
// (undocumented)
|
|
221
|
+
registerResult(): void;
|
|
222
|
+
// (undocumented)
|
|
223
|
+
render(): JSX.Element;
|
|
224
|
+
// (undocumented)
|
|
225
|
+
state: {
|
|
226
|
+
isMouseSelected: boolean;
|
|
227
|
+
};
|
|
232
228
|
}
|
|
233
229
|
|
|
234
230
|
// @public (undocumented)
|
|
235
231
|
export type ResultBaseProps = CommonResultProps & {
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
232
|
+
type: string;
|
|
233
|
+
text: React_2.ReactNode;
|
|
234
|
+
subText?: React_2.ReactNode;
|
|
235
|
+
caption?: string;
|
|
236
|
+
icon?: React_2.ReactNode;
|
|
237
|
+
context?: ResultContextType;
|
|
242
238
|
};
|
|
243
239
|
|
|
244
240
|
// @public (undocumented)
|
|
245
241
|
type ResultContextType = {
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
242
|
+
registerResult: (result: ResultBase_2) => void;
|
|
243
|
+
unregisterResult: (result: ResultBase_2) => void;
|
|
244
|
+
onMouseEnter: (resultData: ResultData) => void;
|
|
245
|
+
onMouseLeave: () => void;
|
|
246
|
+
sendAnalytics?: (eventName: string, eventData: Object) => void;
|
|
247
|
+
getIndex: (resultId: ResultId) => null | number;
|
|
248
|
+
linkComponent?: ComponentType;
|
|
253
249
|
};
|
|
254
250
|
|
|
255
251
|
// @public (undocumented)
|
|
256
252
|
export type ResultData = {
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
253
|
+
resultId: ResultId;
|
|
254
|
+
type: string;
|
|
255
|
+
event: CancelableEvent;
|
|
260
256
|
};
|
|
261
257
|
|
|
262
258
|
// @public (undocumented)
|
|
@@ -264,8 +260,8 @@ type ResultId = number | string;
|
|
|
264
260
|
|
|
265
261
|
// @public (undocumented)
|
|
266
262
|
class ResultItemGroup extends React_2.Component<Props> {
|
|
267
|
-
|
|
268
|
-
|
|
263
|
+
// (undocumented)
|
|
264
|
+
render(): JSX.Element;
|
|
269
265
|
}
|
|
270
266
|
export { ResultItemGroup as AkNavigationItemGroup };
|
|
271
267
|
export { ResultItemGroup };
|
|
@@ -284,8 +280,8 @@ type SelectedResultId = ResultId | null;
|
|
|
284
280
|
|
|
285
281
|
```json
|
|
286
282
|
{
|
|
287
|
-
|
|
288
|
-
|
|
283
|
+
"react": "^16.8.0",
|
|
284
|
+
"styled-components": "^3.2.6"
|
|
289
285
|
}
|
|
290
286
|
```
|
|
291
287
|
|