DocsBrowse documentation
Companion Packages
Overview
Companion packages add app-owned metadata or compatibility tooling around the picker without changing the picker contract itself.
Use the base and extended picker APIs on their own when you only need the picker surface. Add a companion package when your app needs broader emoji metadata, build-time artifacts, or native compatibility policy outside the picker itself.
@slithy/emoji-transforms
Install this package when your app needs richer native search terms, native labels, or native shortcode metadata.
pnpm add @slithy/emoji-transformsReach for it when:
- richer native search vocabulary than the built-in dataset provides
- localized native emoji labels without keeping full locale datasets in app state
- app-specific shortcode or alias policy
- build-time metadata artifacts owned by your app
This package does not change the picker component surface. It transforms emoji datasets into plain maps that your app can pass into the picker or use elsewhere.
It does not:
- fetch or host emoji assets
- render anything itself
- decide compatibility policy for older platforms
Go next:
- Search & Metadata for grouped vs. unified search, enrichment, fallback search, and multilanguage maps
- Recipes for shortcode-first apps, reactions UI, and multilingual app patterns
- API Reference for the full exported surface
@slithy/emoji-compat
Install this package when your app needs native emoji support detection, fallback asset preparation, or fallback image URL resolution for emoji above your supported browser floor.
pnpm add @slithy/emoji-compatReach for it when:
- browser support probing for native emoji rendering
- a compat map that marks which emoji need fallback images
- hexcode-based fallback URL resolution for self-hosted or CDN emoji assets
- build-time fallback asset manifest generation
This package does not render anything itself. It helps your app decide when native glyphs are enough and when an asset fallback is needed.
It does not:
- know anything about custom emoji
- change the picker component surface
- bundle or host fallback assets for you
Go next:
- Recipes for a reaction UI example that branches between custom emoji images and native compat fallback
- API Reference for the compat APIs and asset helpers
Notes
- Companion packages are optional. The picker APIs work without them.
- See the Search & Metadata page for workflow-oriented examples.
- See the Recipes page for end-to-end integration patterns.