---
title: "Custom Emoji"
description: "An uploaded emoji that sits on the text baseline and reads as :name:."
---

An uploaded emoji that sits on the text baseline and reads as :name:. Compose it from the exported registry parts so local content and behaviour stay in the application while the visual contract stays token-driven.

_Live example of Custom Emoji — see the page for the rendered demo._

## Installation

```bash
npx newtui@latest add custom-emoji
```

npm dependencies: class-variance-authority.

Files written — React: components/ui/custom-emoji.tsx. Vue: components/ui/custom-emoji/CustomEmoji.vue, components/ui/custom-emoji/index.ts.

## Usage

React:

```tsx
import { CustomEmoji } from "@/components/ui/custom-emoji"
```

Vue:

```ts
import { CustomEmoji } from "@/components/ui/custom-emoji"
```

## API reference

**`CustomEmoji`**

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `children / default slot` | `React.ReactNode / Vue slot` | — | Content rendered inside the component. |
| `className / class` | `string` | — | Additional classes merged with the component defaults. |

## Accessibility

Preserve the native semantics of the rendered elements and pass through ARIA attributes when the surrounding context needs a label or description. Any interactive child needs a visible focus indicator, and meaning must not rely on colour alone.

## Tokens

Custom Emoji reads its colours, radii and motion from the `--newt-*` tokens. Override a token rather than editing the component.