UNPKG

@empathyco/x-components

Version:
25 lines (16 loc) 1.13 kB
<!-- 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 | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [image](./x-types.banner.image.md) | | string | Banner image. | | [position?](./x-types.banner.position.md) | | number | _(Optional)_ Banner position (= row) inside the grid. | | [title?](./x-types.banner.title.md) | | string | _(Optional)_ Banner title. | | [url?](./x-types.banner.url.md) | | string | _(Optional)_ URL to redirect. |