react-emoji-styles 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 emoji-styles contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # react-emoji-styles
2
+
3
+ React 18 and 19 primitives for consistent, accessible emoji across operating
4
+ systems, providers, themes, SSR, and hydration.
5
+
6
+ ## Install
7
+
8
+ ```bash
9
+ npm install react-emoji-styles
10
+ ```
11
+
12
+ ## Quick start
13
+
14
+ ```tsx
15
+ import { Emoji, EmojiProvider, publicProviders } from "react-emoji-styles";
16
+ import "react-emoji-styles/styles.css";
17
+
18
+ export function App() {
19
+ return (
20
+ <EmojiProvider
21
+ provider={publicProviders.fluent3d}
22
+ fallbacks={[publicProviders.twemoji]}
23
+ nativeFallback={false}
24
+ >
25
+ <Emoji emoji="🚀" label="Launch project" size="xl" />
26
+ </EmojiProvider>
27
+ );
28
+ }
29
+ ```
30
+
31
+ The package also exports `EmojiToken`, `EmojiText`, `EmojiGrid`, provider
32
+ configuration, semantic themes, and resolution hooks.
33
+
34
+ - [Interactive demo](https://emoji-styles.space)
35
+ - [React documentation](https://github.com/Blancochuy/emoji-styles/blob/master/docs/REACT.md)
36
+ - [Source repository](https://github.com/Blancochuy/emoji-styles)
37
+
38
+ ## License
39
+
40
+ Source code is MIT licensed. Provider artwork may use separate licenses; review
41
+ the project's
42
+ [third-party notices](https://github.com/Blancochuy/emoji-styles/blob/master/docs/THIRD_PARTY_NOTICES.md).
@@ -0,0 +1,166 @@
1
+ import * as react from 'react';
2
+ import { HTMLAttributes, ReactElement, ReactNode } from 'react';
3
+ import * as emoji_styles from 'emoji-styles';
4
+ import { EmojiStyle, EmojiProviderRef, EmojiSize, EmojiResolution, EmojiTheme, EmojiThemeProviderRef, EmojiAssetProvider, ResolvedEmojiToken, EmojiStylesConfig, getEmojiTokenDefinition } from 'emoji-styles';
5
+ export { EmojiAssetProvider, EmojiData, EmojiProviderRef, EmojiSize, EmojiStyle, EmojiTheme, EmojiThemeProviderRef, EmojiTokenDefinition, ProviderLicense, ResolvedEmojiToken, SemanticTokenProvider, createCdnProvider, createMappedProvider, createSemanticTokenProvider, defineEmojiTheme, experimentalProviders, getAvailableEmojis, getEmojiData, hasEmoji, mergeEmojiThemes, providers, publicProviders, resolveEmojiToken, serializeEmojiTheme, tokenizeEmojiText, validateEmojiTheme } from 'emoji-styles';
6
+
7
+ interface EmojiFallbackEvent {
8
+ emoji: string;
9
+ from: string | null;
10
+ to: string | null;
11
+ index: number;
12
+ native: boolean;
13
+ }
14
+ interface EmojiErrorEvent {
15
+ emoji: string;
16
+ url: string;
17
+ providerId: string;
18
+ index: number;
19
+ }
20
+ interface EmojiComponentProps {
21
+ emoji: string;
22
+ style?: EmojiStyle;
23
+ provider?: EmojiProviderRef;
24
+ fallbacks?: readonly EmojiProviderRef[];
25
+ /** Append native OS emoji after the configured provider chain. Defaults to true. */
26
+ nativeFallback?: boolean;
27
+ size?: EmojiSize;
28
+ className?: string;
29
+ /** Accessible label. Defaults to the CLDR label from the bundled dataset. */
30
+ label?: string;
31
+ /** @deprecated Use label. */
32
+ alt?: string;
33
+ decorative?: boolean;
34
+ loading?: "lazy" | "eager";
35
+ /** @deprecated Use loading="lazy" or loading="eager". */
36
+ lazy?: boolean;
37
+ /** @deprecated Use nativeFallback. */
38
+ fallback?: boolean;
39
+ onResolve?: (resolution: EmojiResolution) => void;
40
+ onFallback?: (event: EmojiFallbackEvent) => void;
41
+ onError?: (event: EmojiErrorEvent) => void;
42
+ }
43
+ declare function Emoji({ emoji, style: styleProp, provider: providerProp, fallbacks: fallbackProps, nativeFallback: nativeFallbackProp, size, className, label: labelProp, alt, decorative, loading: loadingProp, lazy, fallback, onResolve, onFallback, onError, }: EmojiComponentProps): react.JSX.Element;
44
+
45
+ interface EmojiTextProps extends Omit<HTMLAttributes<HTMLSpanElement>, "children" | "onError"> {
46
+ children: string;
47
+ provider?: EmojiProviderRef;
48
+ fallbacks?: readonly EmojiProviderRef[];
49
+ nativeFallback?: boolean;
50
+ size?: EmojiSize;
51
+ emojiClassName?: string;
52
+ lazy?: boolean;
53
+ loading?: "lazy" | "eager";
54
+ /** @deprecated Use nativeFallback. */
55
+ fallback?: boolean;
56
+ decorative?: boolean;
57
+ onResolve?: EmojiComponentProps["onResolve"];
58
+ onFallback?: EmojiComponentProps["onFallback"];
59
+ onError?: EmojiComponentProps["onError"];
60
+ getAlt?: (emoji: string) => string;
61
+ /** Replace selected tokens with design-system components while retaining the default renderer. */
62
+ renderEmoji?: (emoji: string, fallback: ReactElement, index: number) => ReactNode;
63
+ }
64
+ /** Render every supported emoji inside a text string through the provider system. */
65
+ declare function EmojiText({ children, provider, fallbacks, nativeFallback, size, emojiClassName, lazy, loading, fallback, decorative, onResolve, onFallback, onError, getAlt, renderEmoji, ...spanProps }: EmojiTextProps): react.JSX.Element;
66
+
67
+ interface EmojiTokenProps {
68
+ token: string;
69
+ theme?: EmojiTheme;
70
+ provider?: EmojiThemeProviderRef;
71
+ fallbacks?: readonly EmojiThemeProviderRef[];
72
+ nativeFallback?: boolean;
73
+ providers?: Readonly<Record<string, EmojiAssetProvider>>;
74
+ locale?: string;
75
+ label?: string;
76
+ decorative?: boolean;
77
+ size?: EmojiSize;
78
+ className?: string;
79
+ lazy?: boolean;
80
+ loading?: "lazy" | "eager";
81
+ /** @deprecated Use nativeFallback. */
82
+ fallback?: boolean;
83
+ onResolve?: (result: ResolvedEmojiToken) => void;
84
+ onFallback?: EmojiComponentProps["onFallback"];
85
+ onError?: EmojiComponentProps["onError"];
86
+ }
87
+ /** Render a design-system token through its theme without coupling UI copy to artwork. */
88
+ declare function EmojiToken({ token, theme, provider, fallbacks, nativeFallback: nativeFallbackProp, providers, locale, label, decorative, size, className, lazy, loading, fallback, onResolve, onFallback, onError, }: EmojiTokenProps): react.JSX.Element;
89
+
90
+ interface EmojiGridProps {
91
+ emojis: string[];
92
+ style?: EmojiStyle;
93
+ provider?: EmojiProviderRef;
94
+ fallbacks?: readonly EmojiProviderRef[];
95
+ nativeFallback?: boolean;
96
+ size?: EmojiSize;
97
+ className?: string;
98
+ gap?: number;
99
+ loading?: "lazy" | "eager";
100
+ decorative?: boolean;
101
+ getLabel?: (emoji: string, index: number) => string | undefined;
102
+ onResolve?: EmojiComponentProps["onResolve"];
103
+ onFallback?: EmojiComponentProps["onFallback"];
104
+ onError?: EmojiComponentProps["onError"];
105
+ }
106
+ /** A thin grid adapter that delegates all rendering and fallback behavior to Emoji. */
107
+ declare function EmojiGrid({ emojis, style, provider, fallbacks, nativeFallback, size, className, gap, loading, decorative, getLabel, onResolve, onFallback, onError, }: EmojiGridProps): react.JSX.Element;
108
+
109
+ interface EmojiContextValue {
110
+ defaultProvider: EmojiProviderRef;
111
+ fallbacks?: readonly EmojiProviderRef[];
112
+ nativeFallback?: boolean;
113
+ theme?: EmojiTheme;
114
+ locale?: string;
115
+ providers?: Readonly<Record<string, EmojiAssetProvider>>;
116
+ }
117
+ declare function useEmojiContext(): EmojiContextValue;
118
+ interface EmojiProviderProps {
119
+ /** Project-level runtime policy, typically imported from emoji-styles.config.ts/json. */
120
+ config?: EmojiStylesConfig;
121
+ provider?: EmojiProviderRef;
122
+ fallbacks?: readonly EmojiProviderRef[];
123
+ /** Append native OS emoji after the configured provider chain. Defaults to true. */
124
+ nativeFallback?: boolean;
125
+ theme?: EmojiTheme;
126
+ locale?: string;
127
+ /** Registry used by serialized themes that reference custom providers by id. */
128
+ providers?: Readonly<Record<string, EmojiAssetProvider>>;
129
+ /** @deprecated Prefer provider for new integrations. */
130
+ defaultStyle?: EmojiStyle;
131
+ children: ReactNode;
132
+ }
133
+ declare function EmojiProvider({ config, provider, fallbacks, nativeFallback, theme, locale, providers, defaultStyle, children }: EmojiProviderProps): react.JSX.Element;
134
+
135
+ interface UseEmojiResult {
136
+ url: string | null;
137
+ exists: boolean;
138
+ resolution: EmojiResolution | null;
139
+ loading: boolean;
140
+ error: Error | null;
141
+ }
142
+ declare function useEmoji(emoji: string, provider?: EmojiProviderRef, fallbacks?: readonly EmojiProviderRef[]): UseEmojiResult;
143
+
144
+ interface UseEmojiTokenOptions {
145
+ theme?: EmojiTheme;
146
+ provider?: EmojiThemeProviderRef;
147
+ fallbacks?: readonly EmojiThemeProviderRef[];
148
+ nativeFallback?: boolean;
149
+ locale?: string;
150
+ providers?: Readonly<Record<string, EmojiAssetProvider>>;
151
+ }
152
+ interface UseEmojiTokenResult {
153
+ definition: ReturnType<typeof getEmojiTokenDefinition>;
154
+ result: ResolvedEmojiToken | null;
155
+ loading: boolean;
156
+ error: Error | null;
157
+ }
158
+ declare function useEmojiToken(token: string, options?: UseEmojiTokenOptions): UseEmojiTokenResult;
159
+
160
+ declare function useEmojiTheme(): {
161
+ theme: emoji_styles.EmojiTheme | undefined;
162
+ locale: string | undefined;
163
+ providers: Readonly<Record<string, emoji_styles.EmojiAssetProvider>> | undefined;
164
+ };
165
+
166
+ export { Emoji, type EmojiComponentProps, type EmojiErrorEvent, type EmojiFallbackEvent, EmojiGrid, type EmojiGridProps, EmojiProvider, type EmojiProviderProps, EmojiText, type EmojiTextProps, EmojiToken, type EmojiTokenProps, type UseEmojiResult, type UseEmojiTokenOptions, type UseEmojiTokenResult, useEmoji, useEmojiContext, useEmojiTheme, useEmojiToken };
package/dist/index.js ADDED
@@ -0,0 +1,561 @@
1
+ "use client";
2
+
3
+ // src/Emoji.tsx
4
+ import { useCallback, useEffect, useMemo as useMemo2, useRef, useState } from "react";
5
+ import {
6
+ getEmojiMetadata,
7
+ getFallbackChain,
8
+ getEmojiUrl,
9
+ publicProviders as publicProviders2,
10
+ resolveEmoji,
11
+ SIZE_MAP
12
+ } from "emoji-styles";
13
+
14
+ // src/EmojiProvider.tsx
15
+ import { createContext, useContext, useMemo } from "react";
16
+ import {
17
+ publicProviders
18
+ } from "emoji-styles";
19
+ import { jsx } from "react/jsx-runtime";
20
+ var EmojiContext = createContext({ defaultProvider: publicProviders.twemoji });
21
+ function useEmojiContext() {
22
+ return useContext(EmojiContext);
23
+ }
24
+ function EmojiProvider({ config, provider, fallbacks, nativeFallback, theme, locale, providers: providers2, defaultStyle, children }) {
25
+ const configProvider = typeof config?.provider === "string" ? providers2?.[config.provider] ?? config.provider : config?.provider;
26
+ const configFallbacks = useMemo(() => config?.fallbacks?.map(
27
+ (fallback) => typeof fallback === "string" ? providers2?.[fallback] ?? fallback : fallback
28
+ ), [config?.fallbacks, providers2]);
29
+ const themeProvider = typeof theme?.defaultProvider === "string" ? providers2?.[theme.defaultProvider] ?? theme.defaultProvider : theme?.defaultProvider;
30
+ const themeFallbacks = useMemo(() => theme?.fallbacks?.map(
31
+ (fallback) => typeof fallback === "string" ? providers2?.[fallback] ?? fallback : fallback
32
+ ), [theme?.fallbacks, providers2]);
33
+ const value = useMemo(() => ({
34
+ defaultProvider: provider ?? defaultStyle ?? configProvider ?? themeProvider ?? publicProviders.twemoji,
35
+ fallbacks: fallbacks ?? configFallbacks ?? themeFallbacks,
36
+ nativeFallback: nativeFallback ?? config?.nativeFallback ?? theme?.nativeFallback,
37
+ theme,
38
+ locale,
39
+ providers: providers2
40
+ }), [provider, fallbacks, nativeFallback, config?.nativeFallback, configProvider, configFallbacks, themeFallbacks, theme, locale, providers2, defaultStyle, themeProvider]);
41
+ return /* @__PURE__ */ jsx(EmojiContext.Provider, { value, children });
42
+ }
43
+
44
+ // src/Emoji.tsx
45
+ import { jsx as jsx2 } from "react/jsx-runtime";
46
+ var DEFAULT_FALLBACKS = [publicProviders2.twemoji];
47
+ function providerId(provider) {
48
+ return typeof provider === "string" ? provider : provider.id;
49
+ }
50
+ function sizeClass(size) {
51
+ if (typeof size !== "number") return `emoji-styles--size-${size}`;
52
+ const preset = Object.entries(SIZE_MAP).find(([, dimension]) => dimension === size)?.[0];
53
+ return preset ? `emoji-styles--size-${preset}` : "emoji-styles--size-custom";
54
+ }
55
+ function NativeEmojiGlyph({ emoji, dimension }) {
56
+ return /* @__PURE__ */ jsx2(
57
+ "svg",
58
+ {
59
+ className: "emoji-styles__native-glyph",
60
+ width: dimension,
61
+ height: dimension,
62
+ viewBox: "0 0 100 100",
63
+ "aria-hidden": "true",
64
+ focusable: "false",
65
+ children: /* @__PURE__ */ jsx2(
66
+ "text",
67
+ {
68
+ className: "emoji-styles__native-text",
69
+ x: "50",
70
+ y: "50",
71
+ textAnchor: "middle",
72
+ dominantBaseline: "central",
73
+ fontSize: "88",
74
+ children: emoji
75
+ }
76
+ )
77
+ }
78
+ );
79
+ }
80
+ function Emoji({
81
+ emoji,
82
+ style: styleProp,
83
+ provider: providerProp,
84
+ fallbacks: fallbackProps,
85
+ nativeFallback: nativeFallbackProp,
86
+ size = "md",
87
+ className = "",
88
+ label: labelProp,
89
+ alt,
90
+ decorative = false,
91
+ loading: loadingProp,
92
+ lazy,
93
+ fallback,
94
+ onResolve,
95
+ onFallback,
96
+ onError
97
+ }) {
98
+ const context = useEmojiContext();
99
+ const provider = providerProp ?? styleProp ?? context.defaultProvider;
100
+ const fallbacks = fallbackProps ?? context.fallbacks ?? DEFAULT_FALLBACKS;
101
+ const nativeFallback = nativeFallbackProp ?? fallback ?? context.nativeFallback ?? true;
102
+ const hasNativeFallback = fallbacks.some((candidate) => providerId(candidate) === publicProviders2.native.id);
103
+ const resolutionFallbacks = useMemo2(
104
+ () => nativeFallback && !hasNativeFallback ? [...fallbacks, publicProviders2.native] : fallbacks,
105
+ [fallbacks, hasNativeFallback, nativeFallback]
106
+ );
107
+ const loading = loadingProp ?? (lazy === false ? "eager" : "lazy");
108
+ const onResolveRef = useRef(onResolve);
109
+ onResolveRef.current = onResolve;
110
+ const metadata = getEmojiMetadata(emoji);
111
+ const label = labelProp ?? alt ?? metadata?.label ?? emoji;
112
+ const dimension = typeof size === "number" ? size : SIZE_MAP[size] ?? SIZE_MAP.md;
113
+ const syncChain = useMemo2(
114
+ () => getFallbackChain(emoji, provider, resolutionFallbacks),
115
+ [emoji, provider, resolutionFallbacks]
116
+ );
117
+ const syncUrl = syncChain[0] ?? getEmojiUrl(emoji, provider);
118
+ const resolutionKey = `${emoji}:${providerId(provider)}:${resolutionFallbacks.map(providerId).join(",")}:${nativeFallback}`;
119
+ const [runtime, setRuntime] = useState(() => ({ key: resolutionKey, chain: syncChain, index: 0, exhausted: false }));
120
+ const current = runtime.key === resolutionKey ? runtime : { key: resolutionKey, chain: syncChain, index: 0, exhausted: false };
121
+ const currentUrl = current.chain[current.index] ?? syncUrl;
122
+ const isNativeProvider = providerId(provider) === publicProviders2.native.id;
123
+ const allowNative = isNativeProvider || hasNativeFallback || nativeFallback;
124
+ const showNative = isNativeProvider || allowNative && (!currentUrl || current.exhausted);
125
+ useEffect(() => {
126
+ let active = true;
127
+ setRuntime({ key: resolutionKey, chain: syncChain, index: 0, exhausted: false });
128
+ resolveEmoji(emoji, { provider, fallbacks: resolutionFallbacks }).then((resolution) => {
129
+ if (!active) return;
130
+ onResolveRef.current?.(resolution);
131
+ const selectedUrl = resolution.selected?.url;
132
+ if (selectedUrl && !syncChain.includes(selectedUrl)) {
133
+ setRuntime({
134
+ key: resolutionKey,
135
+ chain: [selectedUrl, ...syncChain],
136
+ index: 0,
137
+ exhausted: false
138
+ });
139
+ }
140
+ }).catch(() => {
141
+ });
142
+ return () => {
143
+ active = false;
144
+ };
145
+ }, [emoji, provider, resolutionKey]);
146
+ const handleError = useCallback(() => {
147
+ if (!currentUrl) return;
148
+ onError?.({
149
+ emoji,
150
+ url: currentUrl,
151
+ providerId: providerId(provider),
152
+ index: current.index
153
+ });
154
+ const nextIndex = current.index + 1;
155
+ const nextUrl = current.chain[nextIndex] ?? null;
156
+ if (nextUrl) {
157
+ setRuntime({ ...current, index: nextIndex });
158
+ onFallback?.({ emoji, from: currentUrl, to: nextUrl, index: nextIndex, native: false });
159
+ return;
160
+ }
161
+ setRuntime({ ...current, exhausted: true });
162
+ onFallback?.({ emoji, from: currentUrl, to: null, index: nextIndex, native: allowNative });
163
+ }, [allowNative, current, currentUrl, emoji, onError, onFallback, provider]);
164
+ const rootClassName = [
165
+ "emoji-styles",
166
+ sizeClass(size),
167
+ decorative ? "emoji-styles--decorative" : "",
168
+ className
169
+ ].filter(Boolean).join(" ");
170
+ if (showNative) {
171
+ return /* @__PURE__ */ jsx2(
172
+ "span",
173
+ {
174
+ className: `${rootClassName} emoji-styles--native`,
175
+ "data-emoji": emoji,
176
+ "data-provider": "native",
177
+ "data-size": dimension,
178
+ role: !decorative && metadata ? "img" : void 0,
179
+ "aria-label": !decorative && metadata ? label : void 0,
180
+ "aria-hidden": decorative || void 0,
181
+ children: /* @__PURE__ */ jsx2(NativeEmojiGlyph, { emoji, dimension })
182
+ }
183
+ );
184
+ }
185
+ if ((!currentUrl || current.exhausted) && !allowNative) {
186
+ return /* @__PURE__ */ jsx2(
187
+ "span",
188
+ {
189
+ className: `${rootClassName} emoji-styles--hidden`,
190
+ "data-emoji": emoji,
191
+ "data-provider": providerId(provider),
192
+ "data-size": dimension,
193
+ "aria-hidden": "true"
194
+ }
195
+ );
196
+ }
197
+ return /* @__PURE__ */ jsx2(
198
+ "span",
199
+ {
200
+ className: rootClassName,
201
+ "data-emoji": emoji,
202
+ "data-provider": providerId(provider),
203
+ "data-size": dimension,
204
+ "aria-hidden": decorative || void 0,
205
+ children: /* @__PURE__ */ jsx2(
206
+ "img",
207
+ {
208
+ src: currentUrl,
209
+ alt: decorative ? "" : label,
210
+ width: dimension,
211
+ height: dimension,
212
+ loading,
213
+ decoding: "async",
214
+ className: "emoji-styles__image",
215
+ draggable: false,
216
+ onError: handleError
217
+ }
218
+ )
219
+ }
220
+ );
221
+ }
222
+
223
+ // src/EmojiText.tsx
224
+ import {
225
+ getEmojiData,
226
+ tokenizeEmojiText
227
+ } from "emoji-styles";
228
+ import { jsx as jsx3 } from "react/jsx-runtime";
229
+ function EmojiText({
230
+ children,
231
+ provider,
232
+ fallbacks,
233
+ nativeFallback,
234
+ size = "md",
235
+ emojiClassName,
236
+ lazy = true,
237
+ loading,
238
+ fallback,
239
+ decorative = false,
240
+ onResolve,
241
+ onFallback,
242
+ onError,
243
+ getAlt,
244
+ renderEmoji,
245
+ ...spanProps
246
+ }) {
247
+ const tokens = tokenizeEmojiText(children);
248
+ return /* @__PURE__ */ jsx3("span", { ...spanProps, children: tokens.map((token, index) => {
249
+ if (token.type === "text") return token.value;
250
+ const defaultRenderer = /* @__PURE__ */ jsx3(
251
+ Emoji,
252
+ {
253
+ emoji: token.value,
254
+ provider,
255
+ fallbacks,
256
+ nativeFallback,
257
+ size,
258
+ className: emojiClassName,
259
+ alt: getAlt?.(token.value) ?? getEmojiData(token.value)?.alt ?? token.value,
260
+ lazy,
261
+ loading,
262
+ fallback,
263
+ decorative,
264
+ onResolve,
265
+ onFallback,
266
+ onError
267
+ }
268
+ );
269
+ return /* @__PURE__ */ jsx3("span", { "data-emoji-token": token.value, children: renderEmoji?.(token.value, defaultRenderer, index) ?? defaultRenderer }, `${token.value}-${index}`);
270
+ }) });
271
+ }
272
+
273
+ // src/EmojiToken.tsx
274
+ import { useEffect as useEffect3, useMemo as useMemo4 } from "react";
275
+ import {
276
+ createMappedProvider,
277
+ publicProviders as publicProviders3
278
+ } from "emoji-styles";
279
+
280
+ // src/useEmojiToken.ts
281
+ import { useEffect as useEffect2, useMemo as useMemo3, useState as useState2 } from "react";
282
+ import {
283
+ getEmojiTokenDefinition,
284
+ resolveEmojiToken
285
+ } from "emoji-styles";
286
+ function useEmojiToken(token, options = {}) {
287
+ const context = useEmojiContext();
288
+ const theme = options.theme ?? context.theme;
289
+ const locale = options.locale ?? context.locale;
290
+ const provider = options.provider;
291
+ const fallbacks = options.fallbacks;
292
+ const nativeFallback = options.nativeFallback ?? context.nativeFallback;
293
+ const providers2 = options.providers ?? context.providers;
294
+ const definition = useMemo3(
295
+ () => theme ? getEmojiTokenDefinition(theme, token) : null,
296
+ [theme, token]
297
+ );
298
+ const [state, setState] = useState2({
299
+ result: null,
300
+ loading: Boolean(theme && definition),
301
+ error: null
302
+ });
303
+ useEffect2(() => {
304
+ let active = true;
305
+ if (!theme || !definition) {
306
+ setState({
307
+ result: null,
308
+ loading: false,
309
+ error: new Error(!theme ? "EmojiToken requires an EmojiTheme" : `Unknown emoji token: ${token}`)
310
+ });
311
+ return () => {
312
+ active = false;
313
+ };
314
+ }
315
+ setState({ result: null, loading: true, error: null });
316
+ resolveEmojiToken(token, theme, { provider, fallbacks, nativeFallback, locale, providers: providers2 }).then((result) => {
317
+ if (active) setState({ result, loading: false, error: null });
318
+ }).catch((error) => {
319
+ if (active) setState({
320
+ result: null,
321
+ loading: false,
322
+ error: error instanceof Error ? error : new Error(String(error))
323
+ });
324
+ });
325
+ return () => {
326
+ active = false;
327
+ };
328
+ }, [theme, definition, token, provider, fallbacks, nativeFallback, locale, providers2]);
329
+ return { definition, ...state };
330
+ }
331
+
332
+ // src/EmojiToken.tsx
333
+ import { jsx as jsx4 } from "react/jsx-runtime";
334
+ function providerForEmoji(provider, registry) {
335
+ if (!provider || typeof provider !== "string") return provider;
336
+ return registry?.[provider] ?? provider;
337
+ }
338
+ function EmojiToken({
339
+ token,
340
+ theme,
341
+ provider,
342
+ fallbacks,
343
+ nativeFallback: nativeFallbackProp,
344
+ providers: providers2,
345
+ locale,
346
+ label,
347
+ decorative,
348
+ size = "md",
349
+ className = "",
350
+ lazy = true,
351
+ loading,
352
+ fallback,
353
+ onResolve,
354
+ onFallback,
355
+ onError
356
+ }) {
357
+ const context = useEmojiContext();
358
+ const effectiveTheme = theme ?? context.theme;
359
+ const nativeFallback = nativeFallbackProp ?? fallback ?? context.nativeFallback ?? effectiveTheme?.nativeFallback ?? true;
360
+ const registry = providers2 ?? context.providers;
361
+ const { definition, result, error } = useEmojiToken(token, {
362
+ theme: effectiveTheme,
363
+ provider,
364
+ fallbacks,
365
+ nativeFallback,
366
+ providers: registry,
367
+ locale
368
+ });
369
+ const resolvedLabel = label ?? result?.label ?? definition?.label ?? token;
370
+ const isDecorative = decorative ?? result?.decorative ?? definition?.decorative ?? false;
371
+ const emoji = result?.emoji ?? definition?.emoji;
372
+ const fallbackProvider = providerForEmoji(
373
+ provider ?? definition?.provider ?? effectiveTheme?.defaultProvider ?? context.defaultProvider,
374
+ registry
375
+ );
376
+ const assetProvider = useMemo4(() => {
377
+ if (!result?.asset || !emoji) return null;
378
+ return createMappedProvider({
379
+ id: `token-${token.replace(/\./g, "-")}`,
380
+ label: resolvedLabel,
381
+ version: result.themeVersion,
382
+ assets: { [emoji]: result.asset.url },
383
+ format: result.asset.format,
384
+ local: result.asset.local,
385
+ license: result.asset.license,
386
+ fallback: typeof fallbackProvider === "object" ? fallbackProvider : void 0
387
+ });
388
+ }, [result, emoji, token, resolvedLabel, fallbackProvider]);
389
+ const emojiFallbacks = useMemo4(
390
+ () => (fallbacks ?? effectiveTheme?.fallbacks ?? []).map((candidate) => providerForEmoji(candidate, registry)).filter((candidate) => Boolean(candidate)),
391
+ [fallbacks, effectiveTheme?.fallbacks, registry]
392
+ );
393
+ useEffect3(() => {
394
+ if (result) onResolve?.(result);
395
+ }, [result, onResolve]);
396
+ if (!emoji) {
397
+ return /* @__PURE__ */ jsx4("span", { className, "data-emoji-token": token, "data-emoji-error": error?.message, children: token });
398
+ }
399
+ const renderProvider = result?.source === "native" ? publicProviders3.native : assetProvider ?? fallbackProvider ?? publicProviders3.native;
400
+ return /* @__PURE__ */ jsx4(
401
+ "span",
402
+ {
403
+ className,
404
+ "data-emoji-token": token,
405
+ "data-emoji-theme": effectiveTheme?.id,
406
+ "data-emoji-source": result?.source ?? "pending",
407
+ "aria-hidden": isDecorative || void 0,
408
+ children: /* @__PURE__ */ jsx4(
409
+ Emoji,
410
+ {
411
+ emoji,
412
+ provider: renderProvider,
413
+ fallbacks: emojiFallbacks,
414
+ nativeFallback,
415
+ size,
416
+ alt: isDecorative ? "" : resolvedLabel,
417
+ lazy,
418
+ loading,
419
+ decorative: isDecorative,
420
+ onFallback,
421
+ onError
422
+ }
423
+ )
424
+ }
425
+ );
426
+ }
427
+
428
+ // src/EmojiGrid.tsx
429
+ import { jsx as jsx5 } from "react/jsx-runtime";
430
+ function EmojiGrid({
431
+ emojis,
432
+ style,
433
+ provider,
434
+ fallbacks,
435
+ nativeFallback,
436
+ size = "md",
437
+ className = "",
438
+ gap = 4,
439
+ loading = "lazy",
440
+ decorative = false,
441
+ getLabel,
442
+ onResolve,
443
+ onFallback,
444
+ onError
445
+ }) {
446
+ return /* @__PURE__ */ jsx5(
447
+ "div",
448
+ {
449
+ className: ["emoji-styles-grid", className].filter(Boolean).join(" "),
450
+ "data-gap": gap,
451
+ role: "list",
452
+ children: emojis.map((emoji, index) => /* @__PURE__ */ jsx5("span", { className: "emoji-styles-grid__cell", role: "listitem", children: /* @__PURE__ */ jsx5(
453
+ Emoji,
454
+ {
455
+ emoji,
456
+ style,
457
+ provider,
458
+ fallbacks,
459
+ nativeFallback,
460
+ size,
461
+ label: getLabel?.(emoji, index),
462
+ decorative,
463
+ loading,
464
+ onResolve,
465
+ onFallback,
466
+ onError
467
+ }
468
+ ) }, `${emoji}-${index}`))
469
+ }
470
+ );
471
+ }
472
+
473
+ // src/useEmoji.ts
474
+ import { useEffect as useEffect4, useMemo as useMemo5, useState as useState3 } from "react";
475
+ import {
476
+ getEmojiUrl as getEmojiUrl2,
477
+ hasEmoji,
478
+ publicProviders as publicProviders4,
479
+ resolveEmoji as resolveEmoji2
480
+ } from "emoji-styles";
481
+ var DEFAULT_HOOK_FALLBACKS = [publicProviders4.native];
482
+ function useEmoji(emoji, provider = publicProviders4.twemoji, fallbacks = DEFAULT_HOOK_FALLBACKS) {
483
+ const fallbackKey = fallbacks.map(
484
+ (fallback) => typeof fallback === "string" ? fallback : fallback.id
485
+ ).join(",");
486
+ const initial = useMemo5(
487
+ () => ({ url: getEmojiUrl2(emoji, provider), exists: hasEmoji(emoji) }),
488
+ [emoji, provider]
489
+ );
490
+ const [state, setState] = useState3({
491
+ resolution: null,
492
+ loading: initial.exists,
493
+ error: null
494
+ });
495
+ useEffect4(() => {
496
+ let active = true;
497
+ if (!initial.exists) {
498
+ setState({ resolution: null, loading: false, error: null });
499
+ return () => {
500
+ active = false;
501
+ };
502
+ }
503
+ setState({ resolution: null, loading: true, error: null });
504
+ resolveEmoji2(emoji, { provider, fallbacks }).then((resolution) => {
505
+ if (active) setState({ resolution, loading: false, error: null });
506
+ }).catch((error) => {
507
+ if (active) setState({
508
+ resolution: null,
509
+ loading: false,
510
+ error: error instanceof Error ? error : new Error(String(error))
511
+ });
512
+ });
513
+ return () => {
514
+ active = false;
515
+ };
516
+ }, [emoji, provider, fallbackKey, initial.exists]);
517
+ return {
518
+ url: state.resolution?.selected?.url ?? initial.url,
519
+ exists: initial.exists,
520
+ ...state
521
+ };
522
+ }
523
+
524
+ // src/useEmojiTheme.ts
525
+ function useEmojiTheme() {
526
+ const context = useEmojiContext();
527
+ return {
528
+ theme: context.theme,
529
+ locale: context.locale,
530
+ providers: context.providers
531
+ };
532
+ }
533
+
534
+ // src/index.ts
535
+ import { providers, publicProviders as publicProviders5, experimentalProviders, createCdnProvider, createMappedProvider as createMappedProvider2, tokenizeEmojiText as tokenizeEmojiText2, getAvailableEmojis, getEmojiData as getEmojiData2, hasEmoji as hasEmoji2, defineEmojiTheme, resolveEmojiToken as resolveEmojiToken2, validateEmojiTheme, mergeEmojiThemes, serializeEmojiTheme, createSemanticTokenProvider } from "emoji-styles";
536
+ export {
537
+ Emoji,
538
+ EmojiGrid,
539
+ EmojiProvider,
540
+ EmojiText,
541
+ EmojiToken,
542
+ createCdnProvider,
543
+ createMappedProvider2 as createMappedProvider,
544
+ createSemanticTokenProvider,
545
+ defineEmojiTheme,
546
+ experimentalProviders,
547
+ getAvailableEmojis,
548
+ getEmojiData2 as getEmojiData,
549
+ hasEmoji2 as hasEmoji,
550
+ mergeEmojiThemes,
551
+ providers,
552
+ publicProviders5 as publicProviders,
553
+ resolveEmojiToken2 as resolveEmojiToken,
554
+ serializeEmojiTheme,
555
+ tokenizeEmojiText2 as tokenizeEmojiText,
556
+ useEmoji,
557
+ useEmojiContext,
558
+ useEmojiTheme,
559
+ useEmojiToken,
560
+ validateEmojiTheme
561
+ };
package/package.json ADDED
@@ -0,0 +1,71 @@
1
+ {
2
+ "name": "react-emoji-styles",
3
+ "version": "0.1.0",
4
+ "description": "React primitives for consistent emoji, semantic asset mappings, and automatic text rendering",
5
+ "sideEffects": [
6
+ "./styles.css"
7
+ ],
8
+ "type": "module",
9
+ "main": "./dist/index.js",
10
+ "module": "./dist/index.js",
11
+ "types": "./dist/index.d.ts",
12
+ "exports": {
13
+ ".": {
14
+ "types": "./dist/index.d.ts",
15
+ "import": "./dist/index.js"
16
+ },
17
+ "./styles.css": "./styles.css"
18
+ },
19
+ "files": [
20
+ "dist",
21
+ "styles.css"
22
+ ],
23
+ "engines": {
24
+ "node": ">=18.17"
25
+ },
26
+ "publishConfig": {
27
+ "access": "public",
28
+ "provenance": true
29
+ },
30
+ "dependencies": {
31
+ "emoji-styles": "0.1.0"
32
+ },
33
+ "peerDependencies": {
34
+ "react": ">=18.0.0 <20.0.0"
35
+ },
36
+ "devDependencies": {
37
+ "@testing-library/jest-dom": "6.6.3",
38
+ "@testing-library/react": "16.3.0",
39
+ "@types/react": "^18.3.0",
40
+ "jsdom": "25.0.1",
41
+ "react": "^18.3.0",
42
+ "react-dom": "^18.3.0",
43
+ "tsup": "^8.0.0",
44
+ "typescript": "^5.5.0",
45
+ "vitest": "^2.1.9"
46
+ },
47
+ "repository": {
48
+ "type": "git",
49
+ "url": "git+https://github.com/Blancochuy/emoji-styles.git",
50
+ "directory": "packages/react"
51
+ },
52
+ "bugs": {
53
+ "url": "https://github.com/Blancochuy/emoji-styles/issues"
54
+ },
55
+ "homepage": "https://emoji-styles.space",
56
+ "keywords": [
57
+ "react",
58
+ "emoji",
59
+ "component",
60
+ "icons",
61
+ "design-system",
62
+ "semantic-ui"
63
+ ],
64
+ "license": "MIT",
65
+ "scripts": {
66
+ "build": "tsup src/index.ts --format esm --dts --clean --external react --external emoji-styles",
67
+ "test": "vitest run",
68
+ "typecheck": "tsc --noEmit",
69
+ "dev": "tsup src/index.ts --format esm --dts --watch --external react"
70
+ }
71
+ }
package/styles.css ADDED
@@ -0,0 +1,73 @@
1
+ .emoji-styles {
2
+ position: relative;
3
+ display: inline-flex;
4
+ align-items: center;
5
+ justify-content: center;
6
+ flex: 0 0 auto;
7
+ vertical-align: -0.125em;
8
+ line-height: 1;
9
+ }
10
+
11
+ .emoji-styles__image {
12
+ position: relative;
13
+ display: block;
14
+ max-width: 100%;
15
+ max-height: 100%;
16
+ object-fit: contain;
17
+ }
18
+
19
+ .emoji-styles__image[src*="/SerenityOS/serenity@"][src*="/Base/res/emoji/"] {
20
+ image-rendering: pixelated;
21
+ }
22
+
23
+ .emoji-styles--hidden {
24
+ display: none;
25
+ }
26
+
27
+ .emoji-styles--native {
28
+ font-family: "Apple Color Emoji", "Segoe UI Emoji", "Noto Color Emoji", sans-serif;
29
+ }
30
+
31
+ .emoji-styles__native-glyph {
32
+ display: block;
33
+ flex: 0 0 auto;
34
+ overflow: visible;
35
+ }
36
+
37
+ .emoji-styles__native-text {
38
+ font-family: "Apple Color Emoji", "Segoe UI Emoji", "Noto Color Emoji", sans-serif;
39
+ }
40
+
41
+ .emoji-styles--size-xs { width: 12px; height: 12px; font-size: 12px; }
42
+ .emoji-styles--size-sm { width: 16px; height: 16px; font-size: 16px; }
43
+ .emoji-styles--size-md { width: 20px; height: 20px; font-size: 20px; }
44
+ .emoji-styles--size-lg { width: 24px; height: 24px; font-size: 24px; }
45
+ .emoji-styles--size-xl { width: 32px; height: 32px; font-size: 32px; }
46
+ .emoji-styles--size-2xl { width: 40px; height: 40px; font-size: 40px; }
47
+ .emoji-styles--size-3xl { width: 48px; height: 48px; font-size: 48px; }
48
+
49
+ .emoji-styles-grid {
50
+ display: grid;
51
+ grid-template-columns: repeat(auto-fill, minmax(2rem, 1fr));
52
+ gap: 0.25rem;
53
+ }
54
+
55
+ .emoji-styles-grid__cell {
56
+ display: grid;
57
+ place-items: center;
58
+ }
59
+
60
+ .emoji-styles-grid[data-gap="0"] { gap: 0; }
61
+ .emoji-styles-grid[data-gap="2"] { gap: 0.125rem; }
62
+ .emoji-styles-grid[data-gap="4"] { gap: 0.25rem; }
63
+ .emoji-styles-grid[data-gap="6"] { gap: 0.375rem; }
64
+ .emoji-styles-grid[data-gap="8"] { gap: 0.5rem; }
65
+ .emoji-styles-grid[data-gap="12"] { gap: 0.75rem; }
66
+ .emoji-styles-grid[data-gap="16"] { gap: 1rem; }
67
+
68
+ @media (prefers-reduced-motion: reduce) {
69
+ .emoji-styles__image {
70
+ animation: none;
71
+ transition: none;
72
+ }
73
+ }