---
title: "App Invite"
description: "The app directory card a link to an app unfurls into inside a message: cover banner, icon, name and a call to action."
---

The card a link to an app's directory page unfurls into inside a message: the app's cover art across the top, its icon and name, an optional one-line pitch and a full-width call to action. Where [Invite](/docs/components/invite) points at a server to join, App Invite points at an app to learn about or add.

_Live example of App Invite — see the page for the rendered demo._

## Installation

```bash
npx newtui@latest add app-invite
``` Registry dependencies, installed with it: button.

Files written — React: components/ui/app-invite.tsx. Vue: components/ui/app-invite/AppInvite.vue, components/ui/app-invite/AppInviteBanner.vue, components/ui/app-invite/AppInviteBody.vue, components/ui/app-invite/AppInviteHeader.vue, components/ui/app-invite/AppInviteIcon.vue, components/ui/app-invite/AppInviteInfo.vue, components/ui/app-invite/AppInviteName.vue, components/ui/app-invite/AppInviteDescription.vue, components/ui/app-invite/index.ts.

## Usage

React:

```tsx
import { AppInvite } from "@/components/ui/app-invite"
```

Vue:

```ts
import { AppInvite, AppInviteBanner, AppInviteBody, AppInviteHeader, AppInviteIcon, AppInviteInfo, AppInviteName, AppInviteDescription } from "@/components/ui/app-invite"
```

Put the action in `AppInviteBody`, after `AppInviteHeader`, and give it `w-full` so it spans the card. Any [Button](/docs/components/button) variant works; `secondary` keeps the card quiet in a busy feed, `primary` makes adding the app the main step.

## API reference

**`AppInviteName`**

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `href` | `string \| undefined` | — | Link to the app's page. Without it the name renders as plain text. |

The registry exports `AppInvite`, `AppInviteBanner`, `AppInviteBody`, `AppInviteHeader`, `AppInviteIcon`, `AppInviteInfo`, `AppInviteName` and `AppInviteDescription`. `AppInvite` renders an `<article>`; `AppInviteBanner` and `AppInviteIcon` render an `<img>` and take `src` and `alt`. Parts without a table accept the native attributes for the element they render; React uses `className`, while Vue uses `class` and fallthrough attributes.

## Accessibility

- Label the card with its name: give `AppInviteName` an `id` and point `aria-labelledby` on `AppInvite` at it, so a screen reader announces "Newt Helper, article".
- The banner and the icon are decorative next to the name, so they default to an empty `alt` and are hidden from assistive technology. Pass `alt` only when the image carries information the text does not.
- Name the action for what it does ("Learn More", "Add App"). When several app cards sit in the same feed, add an `aria-label` that includes the app name, so the links are distinguishable out of context.
- The description is clamped to two lines visually; the full text is still read out.

## Tokens

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