Skip to content
 
 

Repository files navigation

@slithy/frimousse

A lightweight, unstyled, and composable emoji picker for React.

  • ⚡️ Lightweight and fast: Dependency-free, tree-shakable, and virtualized with minimal re-renders
  • 🎨 Unstyled and composable: Bring your own styles and compose parts as you want
  • 🗂️ Consumer-owned emoji data delivery: Fetch Emojibase data at runtime by default, or self-host the same files when you want tighter control
  • 🔣 No � symbols: Unsupported emojis are automatically hidden
  • ♿️ Accessible: Keyboard navigable and screen reader-friendly

Fork purpose

This repository is a compatibility-conscious fork of Frimousse.

The goal of the fork is:

  • preserve the baseline picker contract for existing consumers
  • add generally useful extension seams rather than app-specific behavior
  • keep fork changes additive and easy to reason about
  • keep future upstream rebases practical by isolating new behavior where possible

Current fork additions include:

  • mixed consumer-defined sections
  • widened selection APIs
  • consumer-owned frequency helpers
  • image-backed custom emoji helpers
  • root-controlled search
  • shortcode display helpers
  • native search enrichment and unified mixed-item search

The upstream project remains the baseline reference for the original picker composition model. Live fork documentation is available at frimousse.slithy.me, and repository-specific extension guidance is also included in guides/extensions.md.

The intended published package identity for this fork is @slithy/frimousse.

Installation

Install the package with:

pnpm add @slithy/frimousse

To adopt the fork, consumers should only need to swap the import source:

import { EmojiPicker } from "@slithy/frimousse";

Usage

Import the EmojiPicker parts and create your own component by composing them.

import { EmojiPicker } from "@slithy/frimousse";

export function MyEmojiPicker() {
  return (
    <EmojiPicker.Root>
      <EmojiPicker.Search />
      <EmojiPicker.Viewport>
        <EmojiPicker.Loading>Loading…</EmojiPicker.Loading>
        <EmojiPicker.Empty>No emoji found.</EmojiPicker.Empty>
        <EmojiPicker.List />
      </EmojiPicker.Viewport>
    </EmojiPicker.Root>
  );
}

Apart from a few sizing and overflow defaults, the parts don’t have any styles out-of-the-box. Being composable, you can bring your own styles and apply them however you want: Tailwind CSS, CSS-in-JS, vanilla CSS via inline styles, classes, or by targeting the [frimousse-*] attributes present on each part.

You might want to use it in a popover rather than on its own. Frimousse only provides the emoji picker itself so if you don’t have a popover component in your app yet, there are several libraries available: Radix UI, Base UI, Headless UI, and React Aria, to name a few.

Documentation

The upstream documentation site remains useful for the baseline picker composition model, but it does not document the fork-specific extensions in this repository.

Live docs for this fork:

Baseline upstream docs and examples:

Additional repository-specific extension guidance for mixed sections, frequent items, custom emoji helpers, and widened selection APIs also lives in guides/extensions.md.

Self-hosting emoji data

The picker can work without the public Emojibase CDN if you host the required JSON files yourself and point emojibaseUrl at that hosted path.

This package includes a small staging CLI for that:

pnpm exec frimousse-stage-emojibase-data --out ./public/emojibase-data

That copies the default en/data.json and en/messages.json files into a public-ready directory. For more than one locale:

pnpm exec frimousse-stage-emojibase-data \
  --out ./public/emojibase-data \
  --locales en,fr,ja

Then point the picker at that path:

<EmojiPicker.Root emojibaseUrl="/emojibase-data">
  <EmojiPicker.Search />
  <EmojiPicker.Viewport>
    <EmojiPicker.Loading>Loading…</EmojiPicker.Loading>
    <EmojiPicker.Empty>No emoji found.</EmojiPicker.Empty>
    <EmojiPicker.List />
  </EmojiPicker.Viewport>
</EmojiPicker.Root>

Compatibility

  • React 18 and 19
  • TypeScript 5.1 and above

Miscellaneous

The name “frimousse” means “little face” in French, and it can also refer to smileys and emoticons.

The emoji picker component was originally created for the Liveblocks Comments default components, within @liveblocks/react-ui.

Credits

The emoji data is based on Emojibase.

Contributing

All contributions are welcome! If you find a bug or have a feature request, feel free to create an issue or a PR.

The project is setup as a monorepo with the frimousse package at the root, a static website in website, and companion packages in packages/*.

Development

Install dependencies and start development builds from the root.

pnpm install
pnpm dev

The static website can be developed separately.

pnpm dev:website

Tests

The package has 95%+ test coverage with Vitest. Some tests use Vitest’s browser mode with Playwright, make sure to install the required browser first.

pnpm exec playwright install chromium

Run the tests.

pnpm test:coverage

Releases

Releases are managed manually with Changesets.

Typical release flow:

pnpm changeset
pnpm changeset version
pnpm release:check
npm_config_userconfig=~/.npmrc pnpm changeset publish

If publish fails with ENEEDAUTH, make sure the command is running in a shell that can read your ~/.npmrc, or keep the npm_config_userconfig=~/.npmrc prefix shown above.

Continuous preview releases are still automatically triggered for every commit in PRs via pkg.pr.new.

About

A lightweight, unstyled, and composable emoji picker for React.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages