# Badge

Source: /tuil/docs/reference/packages/ink/api/badge
Locale: en

function exported by @mwillbanks/tuil-ink.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-ink`.

```ts
export function Badge({
  tone = "neutral",
  children,
  ...props
}: BadgeProps): ReactNode;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member                                                     | Type         | Required | Description                                                                                    | Related types                                                |
| ---------------------------------------------------------- | ------------ | -------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| `{   tone = "neutral",   children,   ...props }` | `BadgeProps` | Yes      | Supplies the `{   tone = "neutral",   children,   ...props }` value as `BadgeProps`. | [`BadgeProps`](/tuil/docs/reference/packages/ink/api/badge-props) |

## Returns [#returns]

`ReactNode` — Returns a value that satisfies `ReactNode`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`BadgeProps`](/tuil/docs/reference/packages/ink/api/badge-props)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ink/src/components.tsx)

## Package [#package]

[@mwillbanks/tuil-ink](/tuil/docs/reference/packages/ink)