@ferrucc-io/emoji-picker
v0.1.1
Published
A beautiful and modern emoji picker for React
Maintainers
Readme
Features
- 🎨 Unstyled & Composable: Built with Tailwind CSS. Every component is minimally styled by default and fully customizable.
- ⚡️ Fast & Lightweight: Virtualized list for smooth scrolling. Only renders emojis in view.
- 🎯 Accessible: Full keyboard and screen reader navigation support.
- 🛜 No external CDNs: All emoji data is included as part of this dependency no external CDNs.
- 🔣 No � symbols: Unsupported emojis are automatically hidden
- 🌈 Dominant Color Hover: Built-in dominant color hover for supported emojis.
- 🖼️ Custom Emojis: Add your own image-based emoji sections (like Slack custom emojis) and a frequently used section.
Installation
To use this component your project must be using React and Tailwind.
To install the component:
bun add @ferrucc-io/emoji-picker
# or
yarn add @ferrucc-io/emoji-picker
# or
npm i @ferrucc-io/emoji-picker
# or
pnpm add @ferrucc-io/emoji-pickerThen in your project you can use the component like this:
<EmojiPicker onEmojiSelect={handleEmojiSelect}>
<EmojiPicker.Header>
<EmojiPicker.Input placeholder="Search emoji" />
</EmojiPicker.Header>
<EmojiPicker.Group>
<EmojiPicker.List />
</EmojiPicker.Group>
</EmojiPicker>Finally, import the component styles in your Tailwind configuration:
// If you're using Tailwind v4.x
// In your CSS file containing your tailwind configuration
// Add this line:
@source "../node_modules/@ferrucc-io/emoji-picker";
// If you're using Tailwind v3.x
// In your tailwind.config.ts
"content": [
// Keep the existing content array
// Add this line:
"./node_modules/@ferrucc-io/emoji-picker/dist/**/*.{js,jsx,ts,tsx}",
],Default Style
<EmojiPicker onEmojiSelect={handleEmojiSelect}>
<EmojiPicker.Header>
<EmojiPicker.Input placeholder="Search emoji" />
</EmojiPicker.Header>
<EmojiPicker.Group>
<EmojiPicker.List />
</EmojiPicker.Group>
</EmojiPicker>Props & Customization
The base component accepts several props for customization:
interface EmojiPickerProps {
emojisPerRow?: number; // Number of emojis per row
emojiSize?: number; // Size of each emoji in pixels
containerHeight?: number; // Height of the emoji container
maxUnicodeVersion?: number; // Maximum Unicode version to include (defaults to 16.0, matching unicode-emoji-json package). Hides unsupported emojis that render as � on the user's system
onEmojiSelect?: (emoji: string) => void; // Callback when emoji is selected
customSections?: CustomSection[]; // Custom image-based emoji sections to show alongside the standard categories
frequentlyUsedEmojis?: (string | CustomEmoji)[]; // Emojis to show in a "Frequently Used" section at the top
renderHeader?: (props: HeaderRendererProps) => React.ReactNode; // Custom renderer for section headers
}Custom Emojis
You can add your own image-based emojis (like Slack custom emojis) via the customSections prop, and pin a "Frequently Used" section at the top of the list with frequentlyUsedEmojis:
import { EmojiPicker } from '@ferrucc-io/emoji-picker';
import type { CustomEmoji, CustomSection } from '@ferrucc-io/emoji-picker';
const customSections: CustomSection[] = [
{
id: 'custom',
name: 'Custom',
priority: 1, // Lower values appear first (defaults to 999)
emojis: [
{ id: 'mic-drop', name: 'mic-drop', imageUrl: '/custom-emojis/mic-drop.gif' },
{ id: 'shipitparrot', name: 'shipitparrot', imageUrl: '/custom-emojis/shipitparrot.gif' },
],
},
];
// Mix standard emoji strings and custom emoji objects
const frequentlyUsedEmojis: (string | CustomEmoji)[] = [
'👍',
'❤️',
{ id: 'thisisfine', name: 'thisisfine', imageUrl: '/custom-emojis/thisisfine.gif' },
];
<EmojiPicker
customSections={customSections}
frequentlyUsedEmojis={frequentlyUsedEmojis}
onEmojiSelect={(emoji) => {
// Standard emojis: the emoji character, e.g. "👍"
// Custom emojis: the name wrapped in colons, e.g. ":mic-drop:"
console.log(emoji);
}}
>
{/* ... */}
</EmojiPicker>Custom emojis are searchable by name, support full keyboard navigation, and show up in the preview just like standard emojis.
The relevant types are exported from the package, along with an isCustomEmoji type guard:
interface CustomEmoji {
id: string;
name: string;
imageUrl: string;
category?: string;
}
interface CustomSection {
id: string;
name: string;
emojis: (EmojiMetadata | CustomEmoji)[];
priority?: number; // Lower values appear first (defaults to 999)
}Custom Section Headers
Use the renderHeader prop to take full control of how section headers are rendered:
import type { HeaderRendererProps } from '@ferrucc-io/emoji-picker';
function MyHeader({ content, isSticky }: HeaderRendererProps) {
return (
<div className={isSticky ? 'bg-white/95 backdrop-blur-sm' : 'bg-transparent'}>
{content}
</div>
);
}
<EmojiPicker renderHeader={MyHeader}>
{/* ... */}
</EmojiPicker>Examples
The main idea behind the component is to be able to support as many different styles as possible. The first version we made supports building a picker that looks like the ones in Slack and Linear.
In the future it would be great to support more styles like the ones in Discord, Whatsapp, Notion etc.
Linear Style
<EmojiPicker
className="border border-zinc-200 dark:border-zinc-800 rounded-lg"
emojisPerRow={12}
emojiSize={28}
onEmojiSelect={onEmojiSelect}
>
<EmojiPicker.Header className="p-2 pb-0">
<EmojiPicker.Input
placeholder="Search emoji"
autoFocus={true}
className="focus:ring-2 focus:ring-inset ring-1 ring-transparent"
/>
</EmojiPicker.Header>
<EmojiPicker.Group>
<EmojiPicker.List hideStickyHeader={true} containerHeight={400} />
</EmojiPicker.Group>
</EmojiPicker>Slack Style
<EmojiPicker
className="font-['Lato'] w-[380px] border-none"
emojisPerRow={9}
emojiSize={36}
>
<EmojiPicker.Header>
<EmojiPicker.Input
placeholder="Search all emoji"
className="h-[36px] bg-white dark:bg-zinc-800 border border-zinc-300 dark:border-zinc-600 w-full rounded-[8px] text-[15px] focus:shadow-[0_0_0_1px_#1d9bd1,0_0_0_6px_rgba(29,155,209,0.3)] dark:focus:shadow-[0_0_0_1px_#1d9bd1,0_0_0_6px_rgba(29,155,209,0.3)] focus:border-transparent focus:outline-none mb-1"
hideIcon
/>
</EmojiPicker.Header>
<EmojiPicker.Group>
<EmojiPicker.List containerHeight={320} />
</EmojiPicker.Group>
<EmojiPicker.Preview>
{({ previewedEmoji }) => (
<>
{previewedEmoji ?
<EmojiPicker.Content />
:
<button>Add Emoji</button>
}
<EmojiPicker.SkinTone />
</>
)}
</EmojiPicker.Preview>
</EmojiPicker>Used by
This project is currently used by:
- June - An analytics product for B2B SaaS
- Langfuse - Traces, evals, prompt management and metrics to debug and improve your LLM application.
- Typefully - The writing app for X, LinkedIn, Threads and more
Feel free to open a PR to add your name here if you're using the component in your project.
Credits
This project was created using bun init in bun v1.2.0. Bun is a fast all-in-one JavaScript runtime.
Contributing
This project is structured as a monorepo with two main parts:
packages/emoji-picker: The main package containing the emoji picker componentdemo: A demo application showcasing different uses of the component
Development Setup
To get started with development:
# Install dependencies for all packages
bun install
# Run the development server
bun devUpdating Emoji Colors
To update the emoji hover colors:
cd packages/emoji-picker
bun run build:emoji-colorsThis will generate a new emojiColors.ts file in the package's src/utils directory.
Testing
# Run tests for the emoji picker package
cd packages/emoji-picker
bun testContributions are welcome! Please feel free to submit a PR.
