UNPKG

@empathyco/x-components

Version:
117 lines (52 loc) 1.44 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [Promoted](./x-types.promoted.md) ## Promoted interface A promoted is an image with a title, that when clicked redirect the user to an URL. Often it is represented taking up the same space than a normal result. **Signature:** ```typescript export interface Promoted extends NamedModel<'Promoted'>, Identifiable, Taggable ``` **Extends:** [NamedModel](./x-types.namedmodel.md)<!-- -->&lt;'Promoted'&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.promoted.image.md) </td><td> </td><td> string </td><td> Promoted image. </td></tr> <tr><td> [position?](./x-types.promoted.position.md) </td><td> </td><td> number </td><td> _(Optional)_ Promoted position inside the grid. </td></tr> <tr><td> [title](./x-types.promoted.title.md) </td><td> </td><td> string </td><td> Promoted title. </td></tr> <tr><td> [url](./x-types.promoted.url.md) </td><td> </td><td> string </td><td> URL to redirect. </td></tr> </tbody></table>