@empathyco/x-components/docs/API-reference/api/x-types.banner.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [Banner](./x-types.banner.md)

## Banner interface

A banner is an image with a title, that when clicked redirect the user to an URL. Often it is represented as a 100% wide element that appears on top of the results inside the grid or between rows.

**Signature:**

```typescript
export interface Banner extends NamedModel<'Banner'>, Identifiable, Taggable 
```
**Extends:** [NamedModel](./x-types.namedmodel.md)<!-- -->&lt;'Banner'&gt;, [Identifiable](./x-types.identifiable.md)<!-- -->, [Taggable](./x-types.taggable.md)

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[image](./x-types.banner.image.md)


</td><td>


</td><td>

string


</td><td>

Banner image.


</td></tr>
<tr><td>

[position?](./x-types.banner.position.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ Banner position (= row) inside the grid.


</td></tr>
<tr><td>

[title?](./x-types.banner.title.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ Banner title.


</td></tr>
<tr><td>

[url?](./x-types.banner.url.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ URL to redirect.


</td></tr>
</tbody></table>