emoji-picker-react 4.0.0-rc.2 → 4.0.0-rc.20

package/README.md

@@ -1,181 +1,201 @@
-# TSDX React w/ Storybook User Guide
+# Emoji Picker React (v4)
 
-Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+An emoji picker component for React applications.
 
-> This TSDX setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
+[Try it live](https://codesandbox.io/s/floral-rgb-z2gkzp?file=/src/App.tsx)
 
-> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
+## What to know before using
 
-## Commands
+- This package assumes it runs in the browser. I have taken many steps to prevent it from failing on the server, but still, it is recommended to only render the component on the client. See troubleshooting section for more information.
 
-TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
+## Installation
 
-The recommended workflow is to run TSDX in one terminal:
-
-```bash
-npm start # or yarn start
 ```
-
-This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
-
-Then run either Storybook or the example playground:
-
-### Storybook
-
-Run inside another terminal:
-
-```bash
-yarn storybook
+npm install emoji-picker-react
 ```
 
-This loads the stories from `./stories`.
-
-> NOTE: Stories should reference the components as if using the library, similar to the example playground. This means importing from the root project directory. This has been aliased in the tsconfig and the storybook webpack config as a helper.
+## Usage:
 
-### Example
+```jsx
+import EmojiPicker from 'emoji-picker-react';
 
-Then run the example inside another:
-
-```bash
-cd example
-npm i # or yarn to install dependencies
-npm start # or yarn start
+function App() {
+  return (
+    <div>
+      <EmojiPicker />
+    </div>
+  );
+}
 ```
 
-The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
-
-To do a one-off build, use `npm run build` or `yarn build`.
-
-To run tests, use `npm test` or `yarn test`.
-
-## Configuration
-
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
-
-### Jest
-
-Jest tests are set up to run with `npm test` or `yarn test`.
-
-### Bundle analysis
-
-Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.
-
-#### Setup Files
-
-This is the folder structure we set up for you:
-
-```txt
-/example
-  index.html
-  index.tsx       # test your component here in a demo app
-  package.json
-  tsconfig.json
-/src
-  index.tsx       # EDIT THIS
-/test
-  blah.test.tsx   # EDIT THIS
-/stories
-  Thing.stories.tsx # EDIT THIS
-/.storybook
-  main.js
-  preview.js
-.gitignore
-package.json
-README.md         # EDIT THIS
-tsconfig.json
+## Features
+
+- Custom click handler
+- Dark mode
+- Customizable styles via css variables
+- Default skin tone selection
+- Skin tone change
+- Different emoji sets (Google, Apple, Facebook, Twitter)
+- Native Emoji support
+
+# Props
+
+The following props are accepted by them picker:
+
+| Prop                | Type     | Default    | Description                                                                                                       |
+| ------------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------- |
+| onEmojiClick        | function |            | Callback function that is called when an emoji is clicked. The function receives the emoji object as a parameter. |
+| autoFocusSearch     | boolean  | `true`     | Controls the auto focus of the search input.                                                                      |
+| Theme               | string   | `light`    | Controls the theme of the picker. Possible values are `light`, `dark` and `auto`.                                 |
+| emojiStyle          | string   | `apple`    | Controls the emoji style. Possible values are `google`, `apple`, `facebook`, `twitter` and `native`.              |
+| defaultSkinTone     | string   | `neutral`  | Controls the default skin tone.                                                                                   |
+| lazyLoadEmojis      | boolean  | `false`    | Controls whether the emojis are loaded lazily or not.                                                             |
+| previewConfig       | object   | `{}`       | Controls the preview of the emoji. See below for more information.                                                |
+| searchPlaceholder   | string   | `Search`   | Controls the placeholder of the search input.                                                                     |
+| suggestedEmojisMode | string   | `frequent` | Controls the suggested emojis mode. Possible values are `frequent` and `recent`.                                  |
+| skinTonesDisabled   | boolean  | `false`    | Controls whether the skin tones are disabled or not.                                                              |
+
+## Full details
+
+- `onEmojiClick`: `(emojiData: EmojiClickData, event: MouseEvent) => void` - Callback function when an emoji is clicked. The callback receives the event and the emoji data. The emoji data is comprised of the following properties:
+
+  ```ts
+  {
+    activeSkinTone: SkinTones;
+    unified: string;
+    unifiedWithoutSkinTone: string;
+    emoji: string;
+    names: string[];
+    getImageUrl: (emojiStyle: EmojiStyle) => string;
+  }
+  ```
+
+- `theme`: `Theme` - The theme of the picker. Can be `light`, `dark` or auto. Default is `light`.
+  The `Theme` enum can be imported from the package.
+
+  ```ts
+  import { Theme } from 'emoji-picker-react';
+  ```
+
+- `emojiStyle`: `EmojiStyle` - The emoji style to use. Can be either `apple`, `google`, `facebook`, `twitter` or `native`. Default is `apple`.
+  The `EmojiStyle` enum can be imported from the package.
+
+  ```ts
+  import { EmojiStyle } from 'emoji-picker-react';
+  ```
+
+* `autoFocusSearch`: `boolean` - Whether to focus the search input on mount. Defaults to `true`.
+*
+* `lazyLoadEmojis`: `boolean` - Whether to lazy load the emojis. Defaults to `false`.
+
+* `defaultSkinTone`: `SkinTones` - The default skin tone to use when an emoji is clicked. Defaults to `SkinTones.Neutral`. Possible skin tones are:
+
+  - ✋ 'neutral'
+  - ✋🏻 '1f3fb'
+  - ✋🏼 '1f3fc'
+  - ✋🏽 '1f3fd'
+  - ✋🏾 '1f3fe'
+  - ✋🏿 '1f3ff'
+
+The skin tones typescript enum can be imported directly from the package:
+
+```ts
+import { SkinTones } from 'emoji-picker-react';
 ```
 
-#### React Testing Library
+- `skinTonesDisabled`: `boolean` - Whether to disable the skin tone selection. Defaults to `false`.
 
-We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
+- `previewConfig`: `PreviewConfig` - Full control over the Preview component, either to show/hide it, change the default emoji or the default caption.
 
-### Rollup
+```ts
+{
+  defaultEmoji: string; // defaults to: "1f60a"
+  defaultCaption: string; // defaults to: "What's your mood?"
+  showPreview: boolean; // defaults to: true
+}
+```
 
-TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
+- `searchPlaceholder`: `string` - The placeholder text for the search input. Defaults to `Search`.
 
-### TypeScript
+- categories: Allows full config over ordering, naming and display of categories.
+  To only sort/omit categories, you can simply pass an array of category names to display:
 
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
+  - 'suggested',
+  - 'smileys_people',
+  - 'animals_nature',
+  - 'food_drink',
+  - 'travel_places',
+  - 'activities',
+  - 'objects',
+  - 'symbols',
+  - 'flags'
 
-## Continuous Integration
+  For a more in-depth configuration, you can pass an array with category config:
 
-### GitHub Actions
+  ```ts
+  [
+    {
+      category: 'suggested',
+      name: 'Recently Used'
+    },
+    {
+      category: 'smileys_people',
+      name: 'Faces...'
+    }
+  ];
+  ```
 
-Two actions are added by default:
+- `suggestedEmojisMode`: `SuggestedEmojisMode` - The mode to use for the suggested emojis. Can be either `recent` or `frequent`. Defaults to `recent`.
+  The `SuggestionMode` enum can be imported from the package.
 
-- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
-- `size` which comments cost comparison of your library on every pull request using [size-limit](https://github.com/ai/size-limit)
+  ```ts
+  import { SuggestionMode } from 'emoji-picker-react';
+  ```
 
-## Optimizations
+# Customization
 
-Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
+The picker can be customized via css variables. The root selector for the picker is `.EmojiPickerReact`, when overriding, make sure to provide a more specific selector.
 
-```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
+In dark mode, the specific selector is `.EmojiPickerReact.epr-dark-theme`.
 
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
-```
+The list of possible variables is quite extensive, but the main ones you may want to override are:
 
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
+- `--epr-picker-width`: The width of the picker.
+- `--epr-picker-height`: The height of the picker.
+- `--epr-emoji-size`: The size of the emojis.
+- `--epr-emoji-gap`: The space between emojis.
 
-## Module Formats
+- `--epr-hover-bg-color` Hovered emoji background color.
+- `--epr-bg-color`: The background color of the picker. When changing it, you should also change `--epr-category-label-bg-color` as they are usually the same color.
+- `--epr-text-color`: The text color in the picker.
 
-CJS, ESModules, and UMD module formats are supported.
+# Troubleshooting
 
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
+## Error Boundary
 
-## Deploying the Example Playground
+emoji-picker-react has a top-level error boundary, trying to catch rendering errors. It won't catch server side related errors, or event handlers errors. If an error is caught, the picker will not render, and a console error will be logged.
 
-The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
+## Next.js
 
-```bash
-cd example # if not already in the example folder
-npm run build # builds to dist
-netlify deploy # deploy the dist folder
-```
+To avoid errors such as "document is not defined" on the server side, you should make sure the library is only imported on the client side. Here is how to do that:
 
-Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
+```javascript
+import dynamic from 'next/dynamic';
 
-```bash
-netlify init
-# build command: yarn build && cd example && yarn && yarn build
-# directory to deploy: example/dist
-# pick yes for netlify.toml
+const Picker = dynamic(
+  () => {
+    return import('emoji-picker-react');
+  },
+  { ssr: false }
+);
 ```
 
-## Named Exports
-
-Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
-
-## Including Styles
+## Vite
 
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
+For reference, if you only need to shim global, you can add
 
-For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
-
-## Publishing to NPM
-
-We recommend using [np](https://github.com/sindresorhus/np).
-
-## Usage with Lerna
-
-When creating a new package with TSDX within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.
-
-The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's `package.json` might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.
-
-Change the `alias` to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.
-
-```diff
-   "alias": {
--    "react": "../node_modules/react",
--    "react-dom": "../node_modules/react-dom"
-+    "react": "../../../node_modules/react",
-+    "react-dom": "../../../node_modules/react-dom"
-   },
+```html
+<script>
+  window.global = window;
+</script>
 ```
-
-An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. [However, that might cause other problems.](https://github.com/palmerhq/tsdx/issues/64)

package/dist/DomUtils/classNames.d.ts

@@ -0,0 +1,11 @@
+export declare enum ClassNames {
+    hiddenOnSearch = "epr-hidden-on-search",
+    searchActive = "epr-search-active",
+    hidden = "epr-hidden",
+    visible = "epr-visible",
+    active = "epr-active",
+    emoji = "epr-emoji",
+    category = "epr-emoji-category",
+    label = "epr-emoji-category-label"
+}
+export declare function asSelectors(...classNames: ClassNames[]): string;

package/dist/DomUtils/elementPositionInRow.d.ts

@@ -0,0 +1,10 @@
+import { NullableElement } from './selectors';
+export declare function elementCountInRow(parent: NullableElement, element: NullableElement): number;
+export declare function elementIndexInRow(parent: NullableElement, element: NullableElement): number;
+export declare function rowNumber(parent: NullableElement, element: NullableElement): number;
+export declare function hasNextRow(parent: NullableElement, element: NullableElement): boolean;
+export declare function getElementInRow(elements: HTMLElement[], row: number, elementsInRow: number, indexInRow: number): NullableElement;
+export declare function getElementInNextRow(allElements: HTMLElement[], currentRow: number, elementsInRow: number, index: number): NullableElement;
+export declare function getElementInPrevRow(allElements: HTMLElement[], currentRow: number, elementsInRow: number, index: number): NullableElement;
+export declare function firstVisibleElementInContainer(parent: NullableElement, elements: HTMLElement[]): NullableElement;
+export declare function hasNextElementSibling(element: HTMLElement): boolean;

package/dist/DomUtils/emojiElementRef.d.ts

@@ -0,0 +1,11 @@
+import { NullableElement } from './selectors';
+export declare type EmojiRef = {
+    current: NullableElement;
+};
+export declare const emojiRef: Record<string, EmojiRef>;
+export declare function getEmojiRef(unified: string): EmojiRef;
+export declare function iterateEmojiRef(callback: (ref: HTMLElement, unified: string) => void): void;
+export declare function hideEmoji(unified: string): void;
+export declare function showEmoji(unified: string): void;
+export declare function hideElement(element: NullableElement): void;
+export declare function showElement(element: NullableElement): void;

package/dist/DomUtils/focusElement.d.ts

@@ -0,0 +1,5 @@
+import { NullableElement } from './selectors';
+export declare function focusElement(element: NullableElement): void;
+export declare function focusPrevElementSibling(element: NullableElement): void;
+export declare function focusNextElementSibling(element: NullableElement): void;
+export declare function focusFirstElementChild(element: NullableElement): void;

package/dist/DomUtils/getActiveElement.d.ts

@@ -0,0 +1,2 @@
+import { NullableElement } from './selectors';
+export declare function getActiveElement(): NullableElement;

package/dist/DomUtils/isDarkTheme.d.ts

@@ -0,0 +1 @@
+export declare function isSystemDarkTheme(): boolean;

package/dist/DomUtils/keyboardNavigation.d.ts

@@ -0,0 +1,7 @@
+import { NullableElement } from './selectors';
+export declare function focusFirstVisibleEmoji(parent: NullableElement): void;
+export declare function focusLastVisibleEmoji(parent: NullableElement): void;
+export declare function focusNextVisibleEmoji(element: NullableElement): void;
+export declare function focusPrevVisibleEmoji(element: NullableElement): void;
+export declare function focusVisibleEmojiOneRowUp(element: NullableElement, exitUp: () => void): void;
+export declare function focusVisibleEmojiOneRowDown(element: NullableElement): void;

package/dist/DomUtils/lastElementChild.d.ts

@@ -0,0 +1,2 @@
+import { NullableElement } from './selectors';
+export declare function lastElementChild(element: NullableElement): NullableElement;

package/dist/DomUtils/scrollCategoryIntoView.d.ts

@@ -1 +1,2 @@
-export declare function scrollCategoryIntoView(root: HTMLElement | null, category: string): void;
+import { NullableElement } from './selectors';
+export declare function scrollCategoryIntoView(root: NullableElement, category: string): void;

package/dist/DomUtils/scrollTo.d.ts

@@ -1 +1,3 @@
-export declare function scrollTo(root: HTMLElement | null, top?: number): void;
+import { NullableElement } from './selectors';
+export declare function scrollTo(root: NullableElement, top?: number): void;
+export declare function useScrollTo(): (top: number) => void;

package/dist/DomUtils/selectors.d.ts

@@ -1,12 +1,24 @@
 import { DataEmoji } from '../dataUtils/DataTypes';
-export declare function buttonFromEmoji(emojiElement: HTMLElement | null): HTMLButtonElement | null;
-export declare function emojiFromElement(element: HTMLElement | null): DataEmoji | undefined;
-export declare function isEmojiElement(element: HTMLElement | null): boolean;
-export declare function closestCategory(element: HTMLElement | null): HTMLElement | null;
-export declare function categoryLabelFromCategory(category: HTMLElement | null): HTMLElement | null;
-export declare function closestCategoryLabel(element: null | HTMLElement): HTMLElement | null;
-export declare function elementHeight(element: HTMLElement | null): number;
-export declare function emojiTrueOffsetTop(element: HTMLElement | null): number;
-export declare function emojiTruOffsetLeft(element: HTMLElement | null): number;
-export declare function unifiedFromEmojiElement(emoji: HTMLElement | null): string | null;
-export declare function originalUnifiedFromEmojiElement(emoji: HTMLElement | null): string | null;
+export declare type NullableElement = HTMLElement | null;
+export declare const EmojiButtonSelector: string;
+export declare const VisibleEmojiSelector: string;
+export declare function buttonFromTarget(emojiElement: NullableElement): HTMLButtonElement | null;
+export declare function emojiFromElement(element: NullableElement): [DataEmoji, string] | [];
+export declare function isEmojiElement(element: NullableElement): boolean;
+export declare function categoryLabelFromCategory(category: NullableElement): NullableElement;
+export declare function closestCategoryLabel(element: NullableElement): NullableElement;
+export declare function elementHeight(element: NullableElement): number;
+export declare function emojiTrueOffsetTop(element: NullableElement): number;
+export declare function emojiTruOffsetLeft(element: NullableElement): number;
+export declare function unifiedFromEmojiElement(emoji: NullableElement): string | null;
+export declare function originalUnifiedFromEmojiElement(emoji: NullableElement): string | null;
+export declare function isVisibleEmoji(element: HTMLElement): boolean;
+export declare function isHidden(element: NullableElement): boolean;
+export declare function allVisibleEmojis(parent: NullableElement): HTMLElement[];
+export declare function lastVisibleEmoji(element: NullableElement): NullableElement;
+export declare function nextVisibleEmoji(element: HTMLElement): NullableElement;
+export declare function prevVisibleEmoji(element: HTMLElement): NullableElement;
+export declare function firstVisibleEmoji(parent: NullableElement): NullableElement;
+export declare function prevCategory(element: NullableElement): NullableElement;
+export declare function nextCategory(element: NullableElement): NullableElement;
+export declare function closestCategory(element: NullableElement): NullableElement;

package/dist/EmojiPickerReact.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { PickerConfig } from './config/config';
+import './EmojiPickerReact.css';
+export interface Props extends PickerConfig {
+}
+export default function EmojiPicker(props: Props): JSX.Element;

package/dist/components/ErrorBoundary.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+export default class ErrorBoundary extends React.Component<{
+    children: React.ReactNode;
+}, {
+    hasError: boolean;
+}> {
+    constructor(props: {
+        children: React.ReactNode;
+    });
+    static getDerivedStateFromError(): {
+        hasError: boolean;
+    };
+    componentDidCatch(error: Error, errorInfo: any): void;
+    render(): number | boolean | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, any> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactFragment | null | undefined;
+}

package/dist/components/body/EmojiCategory.d.ts

@@ -5,6 +5,7 @@ declare type Props = Readonly<{
     categoryConfig: CategoryConfig;
     children?: React.ReactNode;
     hidden?: boolean;
+    hiddenOnSearch?: boolean;
 }>;
-export declare function EmojiCategory({ categoryConfig, children, hidden }: Props): JSX.Element;
+export declare function EmojiCategory({ categoryConfig, children, hidden, hiddenOnSearch }: Props): JSX.Element;
 export {};

package/dist/components/body/{RecentlyUsed.d.ts → Suggested.d.ts}

@@ -3,5 +3,5 @@ import { CategoryConfig } from '../../config/categoryConfig';
 declare type Props = Readonly<{
     categoryConfig: CategoryConfig;
 }>;
-export declare function RecentlyUsed({ categoryConfig }: Props): JSX.Element | null;
+export declare function Suggested({ categoryConfig }: Props): JSX.Element;
 export {};

package/dist/components/context/ElementRefContext.d.ts

@@ -1,17 +1,13 @@
 import * as React from 'react';
+import { NullableElement } from '../../DomUtils/selectors';
 export declare function ElementRefContextProvider({ children }: {
     children: React.ReactNode;
 }): JSX.Element;
-export declare type ElementRef = React.MutableRefObject<HTMLElement | null>;
-declare type ElementRefs = {
-    PickerMainRef: ElementRef;
-    AnchoredEmojiRef: ElementRef;
-    BodyRef: React.MutableRefObject<HTMLElement | null>;
-};
-declare type ElementRefKeys = keyof ElementRefs;
-export declare function useElementRef(key: ElementRefKeys): ElementRef | React.MutableRefObject<HTMLElement | null>;
-export declare function usePickerMainRef(): ElementRef | React.MutableRefObject<HTMLElement | null>;
-export declare function useAnchoredEmojiRef(): ElementRef | React.MutableRefObject<HTMLElement | null>;
-export declare function useSetAnchoredEmojiRef(): (target: null | HTMLElement) => void;
-export declare function useBodyRef(): React.MutableRefObject<HTMLDivElement | null>;
-export {};
+export declare type ElementRef<E extends HTMLElement = HTMLElement> = React.MutableRefObject<E | null>;
+export declare function usePickerMainRef(): ElementRef<HTMLElement>;
+export declare function useAnchoredEmojiRef(): ElementRef<HTMLElement>;
+export declare function useSetAnchoredEmojiRef(): (target: NullableElement) => void;
+export declare function useBodyRef(): ElementRef<HTMLDivElement>;
+export declare function useSearchInputRef(): ElementRef<HTMLInputElement>;
+export declare function useSkinTonePickerRef(): ElementRef<HTMLDivElement>;
+export declare function useCategoryNavigationRef(): ElementRef<HTMLDivElement>;

package/dist/components/context/PickerContext.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
-import { SkinTones } from '../../data/skinToneVariations';
 import { DataEmoji } from '../../dataUtils/DataTypes';
 import { FilterDict } from '../../hooks/useFilter';
+import { SkinTones } from '../../types/exposedTypes';
 export declare function PickerContextProvider({ children }: Props): JSX.Element;
 declare type ReactState<T> = [T, React.Dispatch<React.SetStateAction<T>>];
 declare type Props = Readonly<{
@@ -9,13 +9,14 @@ declare type Props = Readonly<{
 }>;
 export declare function useFilterRef(): React.MutableRefObject<Record<string, Record<string, DataEmoji>>>;
 export declare function useDisallowClickRef(): React.MutableRefObject<boolean>;
-export declare function useSearchTermState(): ReactState<string>;
+export declare function useSearchTermState(): [string, (term: string) => Promise<string>];
 export declare function useActiveCategoryState(): [ActiveCategoryState, (nextActive: string) => void, (nextActive: string) => void];
 export declare function useActiveSkinToneState(): [SkinTones, (skinTone: SkinTones) => void];
 export declare function useEmojisThatFailedToLoadState(): ReactState<Set<string>>;
 export declare function useIsPastInitialLoad(): boolean;
 export declare function useEmojiVariationPickerState(): ReactState<DataEmoji | null>;
 export declare function useSkinToneFanOpenState(): ReactState<boolean>;
+export declare function useUpdateSuggested(): [number, () => void];
 export declare type FilterState = Record<string, FilterDict>;
 declare type ActiveCategoryState = null | string;
 export {};

package/dist/components/emoji/Emoji.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="react" />
-import { EmojiStyle } from '../../config/config';
+import { EmojiRef } from '../../DomUtils/emojiElementRef';
 import { DataEmoji } from '../../dataUtils/DataTypes';
+import { EmojiStyle } from '../../types/exposedTypes';
 import './Emoji.css';
 declare type Props = Readonly<{
     hidden?: boolean;
@@ -9,6 +10,8 @@ declare type Props = Readonly<{
     unified: string;
     showVariations?: boolean;
     size?: number;
+    emojiRef?: EmojiRef;
+    lazyLoad?: boolean;
 }>;
-export declare function Emoji({ emoji, unified, hidden, emojiStyle, showVariations, size }: Props): JSX.Element;
+export declare function Emoji({ emoji, unified, hidden, emojiStyle, showVariations, size, emojiRef, lazyLoad }: Props): JSX.Element;
 export {};

package/dist/components/footer/Preview.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import './Preview.css';
 export declare function Preview(): JSX.Element | null;
-export declare type HoveredEmoji = null | {
+export declare type PreviewEmoji = null | {
     unified: string;
     originalUnified: string;
 };

package/dist/config/categoryConfig.d.ts

@@ -1,15 +1,7 @@
-export declare enum Categories {
-    RECENTLY_USED = "recently_used",
-    SMILEYS_PEOPLE = "smileys_people",
-    ANIMALS_NATURE = "animals_nature",
-    FOOD_DRINK = "food_drink",
-    TRAVEL_PLACES = "travel_places",
-    ACTIVITIES = "activities",
-    OBJECTS = "objects",
-    SYMBOLS = "symbols",
-    FLAGS = "flags"
-}
-export declare const baseCategoriesConfig: CategoryConfig[];
+import { Categories, SuggestionMode } from '../types/exposedTypes';
+export { Categories };
+export declare const SuggestedRecent: CategoryConfig;
+export declare function baseCategoriesConfig(modifiers?: Record<Categories, CategoryConfig>): CategoriesConfig;
 export declare function categoryFromCategoryConfig(category: CategoryConfig): Categories;
 export declare function categoryNameFromCategoryConfig(category: CategoryConfig): string;
 export declare type CategoriesConfig = CategoryConfig[];
@@ -18,4 +10,7 @@ export declare type CategoryConfig = {
     name: string;
 };
 export declare type UserCategoryConfig = Array<Categories | CategoryConfig>;
-export declare function mergeCategoriesConfig(userCategoriesConfig?: UserCategoryConfig): CategoriesConfig;
+export declare function mergeCategoriesConfig(userCategoriesConfig?: UserCategoryConfig, modifiers?: CategoryConfigModifiers): CategoriesConfig;
+declare type CategoryConfigModifiers = {
+    suggestionMode?: SuggestionMode;
+};

package/dist/config/cdnUrls.d.ts

@@ -1,2 +1,2 @@
-import { EmojiStyle } from './config';
+import { EmojiStyle } from "../types/exposedTypes";
 export declare function cdnUrl(emojiStyle: EmojiStyle): string;