# BadgeIconProperties

Canonical page: https://www.adaptabletools.com/docs/reference/badgeiconproperties

Icon settings for a  — the icon itself plus its
placement and behaviour inside the pill. All four properties are tightly
coupled (the placement / gap / icon-only flags are only meaningful when an
`Icon` is set) so they live together in a single nested object.

```ts title="TypeScript"
export interface BadgeIconProperties 
```

## Properties

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [Gap](https://www.adaptabletools.com/docs/reference/badgeiconproperties.md#gap) | `number` | Pixel gap between the icon and the badge text. Falls back to the badge<br/>`Density` preset when omitted; ignored when  is `true`. |   |
| [Icon](https://www.adaptabletools.com/docs/reference/badgeiconproperties.md#icon) | [`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md) | Icon to display in the badge. |   |
| [IconOnly](https://www.adaptabletools.com/docs/reference/badgeiconproperties.md#icononly) | `boolean` | Only show the icon and no badge text. |   |
| [Position](https://www.adaptabletools.com/docs/reference/badgeiconproperties.md#position) | `'Start' \| 'End'` | Position of the icon in the badge — `'Start'` or `'End'`. | &#39;Start&#39; |

## Property Details

### Gap

Pixel gap between the icon and the badge text. Falls back to the badge
`Density` preset when omitted; ignored when  is `true`.

```ts title="TypeScript"
Gap?: number;
```

###### Property Value

`number`

### Icon

Icon to display in the badge.

```ts title="TypeScript"
Icon: AdaptableIcon;
```

###### Property Value

[`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md)

### IconOnly

Only show the icon and no badge text.

```ts title="TypeScript"
IconOnly?: boolean;
```

###### Property Value

`boolean`

### Position

Position of the icon in the badge — `'Start'` or `'End'`.

```ts title="TypeScript"
Position?: 'Start' | 'End';
```

###### Default Value

&#39;Start&#39;

###### Property Value

`'Start' | 'End'`