@atlaskit/quick-search 8.0.13 → 8.0.15

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.
Files changed (66) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +1 -0
  3. package/dist/cjs/components/QuickSearch.js +65 -100
  4. package/dist/cjs/components/ResultItem/ResultItem.js +0 -22
  5. package/dist/cjs/components/ResultItem/ResultItemGroup.js +2 -20
  6. package/dist/cjs/components/ResultItem/styled.js +4 -27
  7. package/dist/cjs/components/Results/ContainerResult.js +6 -31
  8. package/dist/cjs/components/Results/ObjectResult.js +9 -36
  9. package/dist/cjs/components/Results/PersonResult.js +8 -34
  10. package/dist/cjs/components/Results/ResultBase.js +22 -52
  11. package/dist/cjs/components/Results/index.js +0 -5
  12. package/dist/cjs/components/Search/Search.js +7 -36
  13. package/dist/cjs/components/Search/styled.js +6 -31
  14. package/dist/cjs/components/constants.js +0 -1
  15. package/dist/cjs/components/context.js +0 -7
  16. package/dist/cjs/components/decorateWithAnalyticsData.js +0 -22
  17. package/dist/cjs/components/isReactElement.js +0 -2
  18. package/dist/cjs/index.js +0 -14
  19. package/dist/cjs/version.json +1 -1
  20. package/dist/es2019/components/QuickSearch.js +71 -95
  21. package/dist/es2019/components/ResultItem/ResultItem.js +0 -4
  22. package/dist/es2019/components/ResultItem/ResultItemGroup.js +0 -1
  23. package/dist/es2019/components/ResultItem/styled.js +6 -7
  24. package/dist/es2019/components/Results/ContainerResult.js +0 -5
  25. package/dist/es2019/components/Results/ObjectResult.js +0 -8
  26. package/dist/es2019/components/Results/PersonResult.js +0 -7
  27. package/dist/es2019/components/Results/ResultBase.js +5 -16
  28. package/dist/es2019/components/Search/Search.js +0 -9
  29. package/dist/es2019/components/Search/styled.js +7 -8
  30. package/dist/es2019/components/decorateWithAnalyticsData.js +0 -4
  31. package/dist/es2019/index.js +6 -3
  32. package/dist/es2019/version.json +1 -1
  33. package/dist/esm/components/QuickSearch.js +66 -104
  34. package/dist/esm/components/ResultItem/ResultItem.js +0 -11
  35. package/dist/esm/components/ResultItem/ResultItemGroup.js +2 -12
  36. package/dist/esm/components/ResultItem/styled.js +4 -7
  37. package/dist/esm/components/Results/ContainerResult.js +6 -22
  38. package/dist/esm/components/Results/ObjectResult.js +9 -27
  39. package/dist/esm/components/Results/PersonResult.js +8 -27
  40. package/dist/esm/components/Results/ResultBase.js +23 -44
  41. package/dist/esm/components/Search/Search.js +7 -28
  42. package/dist/esm/components/Search/styled.js +7 -10
  43. package/dist/esm/components/decorateWithAnalyticsData.js +0 -13
  44. package/dist/esm/index.js +6 -3
  45. package/dist/esm/version.json +1 -1
  46. package/dist/types/components/Search/styled.d.ts +1 -1
  47. package/package.json +8 -14
  48. package/report.api.md +33 -14
  49. package/tmp/api-report-tmp.d.ts +263 -0
  50. package/dist/types-ts4.0/components/QuickSearch.d.ts +0 -122
  51. package/dist/types-ts4.0/components/ResultItem/ResultItem.d.ts +0 -38
  52. package/dist/types-ts4.0/components/ResultItem/ResultItemGroup.d.ts +0 -11
  53. package/dist/types-ts4.0/components/ResultItem/styled.d.ts +0 -13
  54. package/dist/types-ts4.0/components/Results/ContainerResult.d.ts +0 -19
  55. package/dist/types-ts4.0/components/Results/ObjectResult.d.ts +0 -22
  56. package/dist/types-ts4.0/components/Results/PersonResult.d.ts +0 -20
  57. package/dist/types-ts4.0/components/Results/ResultBase.d.ts +0 -37
  58. package/dist/types-ts4.0/components/Results/index.d.ts +0 -4
  59. package/dist/types-ts4.0/components/Results/types.d.ts +0 -34
  60. package/dist/types-ts4.0/components/Search/Search.d.ts +0 -31
  61. package/dist/types-ts4.0/components/Search/styled.d.ts +0 -10
  62. package/dist/types-ts4.0/components/constants.d.ts +0 -6
  63. package/dist/types-ts4.0/components/context.d.ts +0 -22
  64. package/dist/types-ts4.0/components/decorateWithAnalyticsData.d.ts +0 -3
  65. package/dist/types-ts4.0/components/isReactElement.d.ts +0 -6
  66. package/dist/types-ts4.0/index.d.ts +0 -17
@@ -1,34 +0,0 @@
1
- import { ReactNode } from 'react';
2
- export declare type AnalyticsData = Object;
3
- export declare type ResultId = string | number;
4
- export declare type SelectedResultId = ResultId | null;
5
- export declare type CancelableEvent = KeyboardEvent | MouseEvent | React.KeyboardEvent<HTMLInputElement> | React.MouseEvent<HTMLElement>;
6
- export declare type ResultData = {
7
- resultId: ResultId;
8
- type: string;
9
- event: CancelableEvent;
10
- };
11
- export declare type CommonResultProps = {
12
- /** Unique ID of the result. This is passed as a parameter to certain callbacks */
13
- resultId: string | number;
14
- /** Type of the result. This is passed as a parameter to certain callbacks. */
15
- type?: string;
16
- /** Src URL of the image to be used as the result's icon, overriden by avatar prop */
17
- avatarUrl?: string;
18
- /** React Component of the image to be used as the result's icon, takes precedence over avatarUrl */
19
- avatar?: ReactNode;
20
- /** Content to be shown after the main content. Shown to the right of content (or to the left in RTL mode). */
21
- elemAfter?: ReactNode;
22
- /** Icon to be shown after the main content when the result is selected */
23
- selectedIcon?: ReactNode;
24
- /** Location to link out to on click. */
25
- href?: string;
26
- /** Target to open the link in. */
27
- target?: string;
28
- /** Reduces padding and font size. */
29
- isCompact?: boolean;
30
- /** Triggered by mouseClick event. */
31
- onClick?: (resultData: ResultData) => void;
32
- /** key/value pairs of attributes to be send in analytics events. */
33
- analyticsData?: AnalyticsData | (() => AnalyticsData);
34
- };
@@ -1,31 +0,0 @@
1
- import React from 'react';
2
- export declare const controlKeys: string[];
3
- declare type Props = {
4
- /** The elements to render as options to search from. */
5
- children?: React.ReactNode;
6
- /** The elements to render to the right of the search input. */
7
- inputControls?: React.ReactNode;
8
- /** Set whether the loading state should be shown. */
9
- isLoading?: boolean;
10
- /** Function to be called when the search input loses focus. */
11
- onBlur?: (event: React.FocusEvent<HTMLInputElement>) => void;
12
- /** Function to be called when a input action occurs (native `oninput` event). */
13
- onInput?: (event: React.FormEvent<HTMLInputElement>) => void;
14
- /** Function to be called when the user hits the escape key. */
15
- onKeyDown?: (event: React.KeyboardEvent<HTMLInputElement>) => void;
16
- /** Placeholder text for search field. */
17
- placeholder?: string;
18
- /** Current value of search field. */
19
- value?: string;
20
- /** Autocomplete information */
21
- autocompleteText?: string;
22
- };
23
- export default class Search extends React.PureComponent<Props> {
24
- static defaultProps: Partial<Props>;
25
- onInputKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
26
- setInputRef: (ref: React.Ref<any>) => void;
27
- renderInputControls: () => JSX.Element | null;
28
- inputRef?: React.Ref<any>;
29
- render(): JSX.Element;
30
- }
31
- export {};
@@ -1,10 +0,0 @@
1
- /// <reference types="react" />
2
- export declare const SearchBox: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, any, import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>>;
3
- export declare const SearchFieldBaseOuter: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, any, import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>>;
4
- export declare const SearchFieldBaseInner: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, any, import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>>;
5
- export declare const SearchInner: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, any, import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>>;
6
- export declare const getPlaceholderStyle: (style: any) => import("styled-components").InterpolationValue[];
7
- export declare const getPlaceholderColor: import("styled-components").FlattenInterpolation<import("styled-components").ThemedStyledProps<import("@atlaskit/theme").ThemeProps | undefined, any>>[];
8
- export declare const SearchInput: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLInputElement> & import("react").InputHTMLAttributes<HTMLInputElement>, any, import("react").ClassAttributes<HTMLInputElement> & import("react").InputHTMLAttributes<HTMLInputElement>>;
9
- export declare const SearchInputTypeAhead: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLInputElement> & import("react").InputHTMLAttributes<HTMLInputElement>, any, import("react").ClassAttributes<HTMLInputElement> & import("react").InputHTMLAttributes<HTMLInputElement>>;
10
- export declare const SearchInputControlsContainer: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLSpanElement> & import("react").HTMLAttributes<HTMLSpanElement>, any, import("react").ClassAttributes<HTMLSpanElement> & import("react").HTMLAttributes<HTMLSpanElement>>;
@@ -1,6 +0,0 @@
1
- export declare const ATLASKIT_QUICKSEARCH_NS = "atlaskit.navigation.quick-search";
2
- export declare const QS_ANALYTICS_EV_CLOSE: string;
3
- export declare const QS_ANALYTICS_EV_KB_CTRLS_USED: string;
4
- export declare const QS_ANALYTICS_EV_OPEN: string;
5
- export declare const QS_ANALYTICS_EV_QUERY_ENTERED: string;
6
- export declare const QS_ANALYTICS_EV_SUBMIT: string;
@@ -1,22 +0,0 @@
1
- import React from 'react';
2
- import { ComponentType } from 'react';
3
- import { ResultData, ResultId, SelectedResultId } from './Results/types';
4
- import { ResultBase } from './Results/ResultBase';
5
- export declare type ResultContextType = {
6
- /** Register result as keyboard navigation target */
7
- registerResult: (result: ResultBase) => void;
8
- /** Unregister result as keyboard navigation target */
9
- unregisterResult: (result: ResultBase) => void;
10
- /** Triggered by mouseEnter event. */
11
- onMouseEnter: (resultData: ResultData) => void;
12
- /** Standard onMouseLeave event. */
13
- onMouseLeave: () => void;
14
- /** Fires an analytics event */
15
- sendAnalytics?: (eventName: string, eventData: Object) => void;
16
- /** get the index of the search result in the list of result */
17
- getIndex: (resultId: ResultId) => number | null;
18
- /** React component to be used for rendering links */
19
- linkComponent?: ComponentType;
20
- };
21
- export declare const ResultContext: React.Context<ResultContextType>;
22
- export declare const SelectedResultIdContext: React.Context<SelectedResultId>;
@@ -1,3 +0,0 @@
1
- import React from 'react';
2
- import { Props } from './QuickSearch';
3
- export default function decorateWithAnalyticsData(WrappedQuickSearch: React.ComponentClass<Props>): React.ComponentClass<Props>;
@@ -1,6 +0,0 @@
1
- declare const _default: (element: any) => boolean;
2
- /**
3
- * Heuristically check whether an element is a react element or not.
4
- * React elements have constructors for their type property but native elements use strings.
5
- */
6
- export default _default;
@@ -1,17 +0,0 @@
1
- import * as resultTypes from './components/Results';
2
- export { default as AkNavigationItemGroup } from './components/ResultItem/ResultItemGroup';
3
- export { default as AkNavigationItem } from './components/ResultItem/ResultItem';
4
- export { default as AkQuickSearch } from './components/QuickSearch';
5
- export { default as AkSearch } from './components/Search/Search';
6
- export { resultTypes as quickSearchResultTypes };
7
- export { default as QuickSearch } from './components/QuickSearch';
8
- export { default as ResultItemGroup } from './components/ResultItem/ResultItemGroup';
9
- export { default as ObjectResult } from './components/Results/ObjectResult';
10
- export type { Props as ObjectResultProps } from './components/Results/ObjectResult';
11
- export { default as PersonResult } from './components/Results/PersonResult';
12
- export type { Props as PersonResultProps } from './components/Results/PersonResult';
13
- export { default as ContainerResult } from './components/Results/ContainerResult';
14
- export type { Props as ContainerResultProps } from './components/Results/ContainerResult';
15
- export { default as ResultBase } from './components/Results/ResultBase';
16
- export type { Props as ResultBaseProps } from './components/Results/ResultBase';
17
- export type { CancelableEvent, ResultData } from './components/Results/types';