emoji-picker-react 4.0.0-rc.3 → 4.0.0-rc.6

package/README.md

@@ -1,181 +1,105 @@
-# 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.
 
-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
 ```
-
-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.
-
-### Example
-
-Then run the example inside another:
-
-```bash
-cd example
-npm i # or yarn to install dependencies
-npm start # or yarn start
+npm install emoji-picker-react
 ```
 
-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).
+## Features
 
-To do a one-off build, use `npm run build` or `yarn build`.
+- 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
 
-To run tests, use `npm test` or `yarn test`.
+## Config Props
 
-## Configuration
+- _onEmojiClick_ `(event: MouseEvent, emoji: EmojiClickData) => 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:
 
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
+  ```ts{
+  activeSkinTone: SkinTones;
+  unified: string;
+  unifiedWithoutSkinTone: string;
+  emoji: string;
+  names: string[];
+  getImageUrl: (emojiStyle: EmojiStyle) => string;
+  }
+  ```
 
-### Jest
+- _theme_ `Theme` - The theme of the picker. Can be either `light` or `dark`. Default is `light`.
+  The `Theme` enum can be imported from the package.
 
-Jest tests are set up to run with `npm test` or `yarn test`.
+  ```ts
+  import { Theme } from 'emoji-picker-react';
+  ```
 
-### Bundle analysis
+- _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.
 
-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`.
+  ```ts
+  import { EmojiStyle } from 'emoji-picker-react';
+  ```
 
-#### Setup Files
+* _autoFocusSearch_: `boolean` - Whether to focus the search input on mount. Defaults to `true`.
 
-This is the folder structure we set up for you:
+* _defaultSkinTone_: `SkinTones` - The default skin tone to use when an emoji is clicked. Defaults to `SkinTones.Neutral`. Possible skin tones are:
 
-```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
 ```
-
-#### React Testing Library
-
-We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
-
-### Rollup
-
-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.
-
-### TypeScript
-
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
-
-## Continuous Integration
-
-### GitHub Actions
-
-Two actions are added by default:
-
-- `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)
-
-## Optimizations
-
-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:
-
-```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
-
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
+  ✋ NEUTRAL = 'neutral'
+  ✋🏻 LIGHT = '1f3fb'
+  ✋🏼 MEDIUM_LIGHT = '1f3fc'
+  ✋🏽 MEDIUM = '1f3fd'
+  ✋🏾 MEDIUM_DARK = '1f3fe'
+  ✋🏿 DARK = '1f3ff'
 ```
 
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
+The skin tones typescript enum can be imported directly from the package:
 
-## Module Formats
+```ts
+import { SkinTones } from 'emoji-picker-react';
+```
 
-CJS, ESModules, and UMD module formats are supported.
+- _skinTonesDisabled_: `boolean` - Whether to disable the skin tone selection. Defaults to `false`.
 
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
+- _showPreview_: `boolean` - Whether to show the preview of the selected emoji. Defaults to `true`.
 
-## Deploying the Example Playground
+- _searchPlaceholder_: `string` - The placeholder text for the search input. Defaults to `Search`.
 
-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`):
+- 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:
 
-```bash
-cd example # if not already in the example folder
-npm run build # builds to dist
-netlify deploy # deploy the dist folder
 ```
-
-Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
-
-```bash
-netlify init
-# build command: yarn build && cd example && yarn && yarn build
-# directory to deploy: example/dist
-# pick yes for netlify.toml
+  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'
 ```
 
-## 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.
+For a more in-depth configuration, you can pass an array with category config:
 
-## Including Styles
-
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
-
-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"
-   },
+```ts
+[{
+  category: Categories.RECENTLY_USED;
+  name: "Recently Used";
+}, {
+  category: Categories.SMILEYS_PEOPLE;
+  name: "Faces...";
+}]
 ```
-
-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,5 @@
+export declare enum ClassNames {
+    hiddenOnSearch = "epr-hidden-on-search",
+    searchActive = "epr-search-active",
+    hidden = "epr-hidden"
+}

package/dist/DomUtils/emojiElementRef.d.ts

@@ -0,0 +1,10 @@
+export declare type EmojiRef = {
+    current: null | HTMLElement;
+};
+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: HTMLElement | null): void;
+export declare function showElement(element: HTMLElement | null): void;

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/context/PickerContext.d.ts

@@ -9,7 +9,7 @@ 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) => void];
 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>>;

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

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

package/dist/config/categoryConfig.d.ts

@@ -1,14 +1,5 @@
-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"
-}
+import { Categories } from '../types/exposedTypes';
+export { Categories };
 export declare const baseCategoriesConfig: CategoryConfig[];
 export declare function categoryFromCategoryConfig(category: CategoryConfig): Categories;
 export declare function categoryNameFromCategoryConfig(category: CategoryConfig): string;

package/dist/emoji-picker-react.cjs.development.css

@@ -10,4 +10,4 @@
 .EmojiPickerReact .epr-skin-tones{align-items:center;display:flex;flex-basis:30px;justify-content:flex-end;transition:all .3s ease-in-out}.EmojiPickerReact .epr-skin-tones.open{flex-basis:170px}.EmojiPickerReact .epr-skin-tone-select{height:16px;position:relative;width:16px}.EmojiPickerReact .epr-skin-tones.open .epr-tone{transition:transform .3s ease-in-out,opacity .3s ease-in-out}.EmojiPickerReact .epr-skin-tones:not(.open) .epr-tone{opacity:0;z-index:0}.EmojiPickerReact .epr-skin-tones .epr-tone{border-radius:4px;box-shadow:0 0 0 0 var(--epr-active-skin-hover-color);cursor:pointer;display:block;height:100%;position:absolute;right:0;transition:transform .3s ease-in-out,opacity .5s ease-in-out;width:100%;z-index:1}.EmojiPickerReact .epr-skin-tones .epr-tone:hover{box-shadow:0 0 0 5px var(--epr-active-skin-hover-color)}.EmojiPickerReact .epr-skin-tones.open .epr-skin-tone-select .epr-tone.active:after{border:1px solid var(--epr-active-skin-tone-indicator-border-color);border-radius:5px;bottom:-2px;content:"";left:-2px;position:absolute;right:-2px;top:-2px}.EmojiPickerReact .epr-skin-tones .epr-tone.active{opacity:1;z-index:1}.EmojiPickerReact .epr-skin-tones .epr-tone.epr-tone-neutral{background-color:#ffd225}.EmojiPickerReact .epr-skin-tones .epr-tone.epr-tone-1f3fb{background-color:#ffdfbd}.EmojiPickerReact .epr-skin-tones .epr-tone.epr-tone-1f3fc{background-color:#e9c197}.EmojiPickerReact .epr-skin-tones .epr-tone.epr-tone-1f3fd{background-color:#c88e62}.EmojiPickerReact .epr-skin-tones .epr-tone.epr-tone-1f3fe{background-color:#a86637}.EmojiPickerReact .epr-skin-tones .epr-tone.epr-tone-1f3ff{background-color:#60463a}
 .EmojiPickerReact .epr-header .epr-header-overlay{padding:var(--epr-header-padding);z-index:var(--epr-header-overlay-z-index)}
 aside.EmojiPickerReact.epr-main{border-color:var(--epr-picker-border-color);border-radius:var(--epr-picker-border-radius);border-style:solid;border-width:1px;display:flex;flex-direction:column;height:var(--epr-picker-height);position:relative;width:var(--epr-picker-width)}
-.EmojiPickerReact{--highlight-color:#007aeb;--hover-backdrop-color:#f1f8ff;--text-color-base:#858585;--epr-header-height:70px;--epr-picker-width:350px;--epr-picker-height:500px;--epr-emoji-size:33px;--epr-category-navigation-button-size:30px;--epr-emoji-variation-picker-bg-color:var(--epr-background-color);--epr-emoji-variation-picker-height:55px;--epr-preview-height:70px;--epr-preview-text-color:var(--text-color-base);--epr-preview-text-size:14px;--epr-preview-text-padding:0 10px;--epr-search-bar-bg-color:#f6f6f6;--epr-active-category-indicator-color:var(--highlight-color);--epr-active-skin-tone-indicator-border-color:var(--highlight-color);--epr-search-border-color:var(--highlight-color);--epr-active-skin-hover-color:var(--hover-backdrop-color);--epr-emoji-hover-color:var(--hover-backdrop-color);--epr-category-label-text-color:var(--text-color-base);--epr-category-label-background-color:#ffffffe6;--epr-emoji-padding:5px;--epr-header-padding:15px 10px;--epr-emoji-gap:4px;--epr-category-padding:0 10px;--epr-search-input-padding:0 30px;--epr-search-input-border-radius:8px;--epr-search-input-height:40px;--epr-category-label-padding:0 10px;--epr-category-label-height:40px;--epr-header-overlay-z-index:3;--epr-emoji-variations-indictator-z-index:1;--epr-category-label-z-index:2;--epr-skin-variation-picker-z-index:5;--epr-picker-border-radius:8px;--epr-search-bar-text-color:var(--text-color-base);--epr-search-bar-placeholder-color:var(--text-color-base);--epr-picker-border-color:#e7e7e7;--epr-background-color:#fff;--epr-preview-border-color:var(--epr-picker-border-color);--epr-search-bar-bg-color-active:var(--epr-search-bar-bg-color);--epr-emoji-variation-indicator-color:rgba(0,0,0,.1);--epr-emoji-variation-indicator-color-hover:rgba(0,0,0,.4)}.EmojiPickerReact.epr-dark-theme{--epr-emoji-variation-picker-bg-color:#000;--highlight-color:silver;--text-color-base:var(--highlight-color);--hover-backdrop-color:#363636f6;--epr-search-bar-bg-color:#333;--epr-category-label-background-color:#222222e6;--epr-picker-border-color:#151617;--epr-background-color:#222;--epr-search-bar-bg-color-active:#000;--epr-emoji-variation-indicator-color:hsla(0,0%,100%,.1);--epr-emoji-variation-indicator-color-hover:hsla(0,0%,100%,.4)}.EmojiPickerReact{background-color:var(--epr-background-color);overflow:hidden}.EmojiPickerReact .hidden{display:none!important;opacity:0!important;pointer-events:none!important;visibility:hidden!important}.EmojiPickerReact *{box-sizing:border-box;font-family:sans-serif}.EmojiPickerReact button{background:none;border:0;cursor:pointer}
+.EmojiPickerReact{--highlight-color:#007aeb;--hover-backdrop-color:#f1f8ff;--text-color-base:#858585;--epr-header-height:70px;--epr-picker-width:350px;--epr-picker-height:500px;--epr-emoji-size:33px;--epr-category-navigation-button-size:30px;--epr-emoji-variation-picker-bg-color:var(--epr-background-color);--epr-emoji-variation-picker-height:55px;--epr-preview-height:70px;--epr-preview-text-color:var(--text-color-base);--epr-preview-text-size:14px;--epr-preview-text-padding:0 10px;--epr-search-bar-bg-color:#f6f6f6;--epr-active-category-indicator-color:var(--highlight-color);--epr-active-skin-tone-indicator-border-color:var(--highlight-color);--epr-search-border-color:var(--highlight-color);--epr-active-skin-hover-color:var(--hover-backdrop-color);--epr-emoji-hover-color:var(--hover-backdrop-color);--epr-category-label-text-color:var(--text-color-base);--epr-category-label-background-color:#ffffffe6;--epr-emoji-padding:5px;--epr-header-padding:15px 10px;--epr-emoji-gap:4px;--epr-category-padding:0 10px;--epr-search-input-padding:0 30px;--epr-search-input-border-radius:8px;--epr-search-input-height:40px;--epr-category-label-padding:0 10px;--epr-category-label-height:40px;--epr-header-overlay-z-index:3;--epr-emoji-variations-indictator-z-index:1;--epr-category-label-z-index:2;--epr-skin-variation-picker-z-index:5;--epr-picker-border-radius:8px;--epr-search-bar-text-color:var(--text-color-base);--epr-search-bar-placeholder-color:var(--text-color-base);--epr-picker-border-color:#e7e7e7;--epr-background-color:#fff;--epr-preview-border-color:var(--epr-picker-border-color);--epr-search-bar-bg-color-active:var(--epr-search-bar-bg-color);--epr-emoji-variation-indicator-color:rgba(0,0,0,.1);--epr-emoji-variation-indicator-color-hover:rgba(0,0,0,.4)}.EmojiPickerReact.epr-dark-theme{--epr-emoji-variation-picker-bg-color:#000;--highlight-color:silver;--text-color-base:var(--highlight-color);--hover-backdrop-color:#363636f6;--epr-search-bar-bg-color:#333;--epr-category-label-background-color:#222222e6;--epr-picker-border-color:#151617;--epr-background-color:#222;--epr-search-bar-bg-color-active:#000;--epr-emoji-variation-indicator-color:hsla(0,0%,100%,.1);--epr-emoji-variation-indicator-color-hover:hsla(0,0%,100%,.4)}.EmojiPickerReact{background-color:var(--epr-background-color);overflow:hidden}.EmojiPickerReact .epr-hidden,.EmojiPickerReact.epr-search-active .epr-hidden-on-search{display:none!important;opacity:0!important;pointer-events:none!important;visibility:hidden!important}.EmojiPickerReact *{box-sizing:border-box;font-family:sans-serif}.EmojiPickerReact button{background:none;border:0;cursor:pointer}