@algolia/autocomplete-shared 1.9.4 → 1.11.0

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.
@@ -6,6 +6,7 @@ import { AutocompletePlugin } from './AutocompletePlugin';
6
6
  import { Reshape } from './AutocompleteReshape';
7
7
  import { AutocompleteSource, InternalAutocompleteSource } from './AutocompleteSource';
8
8
  import { AutocompleteState } from './AutocompleteState';
9
+ export declare type AutocompleteEnterKeyHint = 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
9
10
  export interface OnSubmitParams<TItem extends BaseItem> extends AutocompleteScopeApi<TItem> {
10
11
  state: AutocompleteState<TItem>;
11
12
  event: any;
@@ -55,6 +56,12 @@ export interface AutocompleteOptions<TItem extends BaseItem> {
55
56
  * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-onstatechange
56
57
  */
57
58
  onStateChange?(props: OnStateChangeProps<TItem>): void;
59
+ /**
60
+ * The action label or icon to present for the enter key on virtual keyboards.
61
+ *
62
+ * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-enterkeyhint
63
+ */
64
+ enterKeyHint?: AutocompleteEnterKeyHint;
58
65
  /**
59
66
  * The placeholder text to show in the search input when there's no query.
60
67
  *
@@ -165,6 +172,7 @@ export interface InternalAutocompleteOptions<TItem extends BaseItem> extends Aut
165
172
  debug: boolean;
166
173
  id: string;
167
174
  onStateChange(props: OnStateChangeProps<TItem>): void;
175
+ enterKeyHint: AutocompleteEnterKeyHint | undefined;
168
176
  placeholder: string;
169
177
  autoFocus: boolean;
170
178
  defaultActiveItemId: number | null;
@@ -1,4 +1,5 @@
1
1
  import { BaseItem } from './AutocompleteApi';
2
+ import { AutocompleteEnterKeyHint } from './AutocompleteOptions';
2
3
  import { InternalAutocompleteSource } from './AutocompleteSource';
3
4
  export interface AutocompletePropGetters<TItem extends BaseItem, TEvent = Event, TMouseEvent = MouseEvent, TKeyboardEvent = KeyboardEvent> {
4
5
  getEnvironmentProps: GetEnvironmentProps;
@@ -58,7 +59,7 @@ export declare type GetInputProps<TEvent, TMouseEvent, TKeyboardEvent> = (props:
58
59
  autoComplete: 'on' | 'off';
59
60
  autoCorrect: 'on' | 'off';
60
61
  autoCapitalize: 'on' | 'off';
61
- enterKeyHint: 'go' | 'search';
62
+ enterKeyHint: AutocompleteEnterKeyHint;
62
63
  spellCheck: 'false';
63
64
  maxLength: number;
64
65
  type: 'search';
@@ -1 +1 @@
1
- export declare const version = "1.9.4";
1
+ export declare const version = "1.11.0";
@@ -1 +1 @@
1
- export var version = '1.9.4';
1
+ export var version = '1.11.0';
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@algolia/autocomplete-shared",
3
3
  "description": "Shared utils for Autocomplete packages.",
4
- "version": "1.9.4",
4
+ "version": "1.11.0",
5
5
  "license": "MIT",
6
6
  "homepage": "https://github.com/algolia/autocomplete",
7
7
  "repository": "algolia/autocomplete",