The info-card component groups information related to a single topic. They often include some text, an image, and a call-to-action button.
Configuration
- Import the
vtex.store-components app to your theme's dependencies in the manifest.json file, as in the following example:
"dependencies": {
"vtex.store-components": "3.x"
}
- Add the
info-card block to the desired page template.
- Add the
info-card block to the same template file using the props stated in the Props table. For example:
"info-card": {
"props": {
"id": "info-card-example",
"isFullModeStyle": false,
"textPosition": "left",
"imageUrl": "https://storecomponents.vteximg.com.br/arquivos/banner-infocard2.png",
"headline": "Clearance Sale",
"callToActionText": "DISCOVER",
"callToActionUrl": "/sale/d",
"blockClass": "info-card-example",
"textAlignment": "center"
}
},
Props
| Prop name | Type | Description | Default value |
|---|
blockClass | String | Extra class name for custom styling. | null |
callToActionLinkTarget | LinkTargetEnum | Where to display the call-to-action component's linked URL, as the name for a browsing context (a tab, window, or iframe) | "_self" |
callToActionMode | CallToActionEnum | Mode of the call-to-action component. | "button" |
callToActionText | String | Text displayed inside the call-to-action component. | "" |
callToActionUrl | String | URL of the call-to-action component. | "" |
headline | String | Headline of the Info Card. | null |
htmlId | String | ID of the container element. | null |
imageUrl | String | Path to the image used on desktop devices. | "" |
imageActionUrl | String | Redirect URL used when the image component is clicked. | "" |
isFullModeStyle | Boolean | Style of the Info Card component. If true, the image component is used as the background and text is displayed over it. | false |
linkTarget | LinkTargetEnum | Where to display the linked URL when the Info Card component is clicked. | "_self" |
mobileImageUrl | String | Path to the image used on mobile devices. If empty, the desktop image is used. | null |
subhead | String | Text to be displayed underneath the headline. If not provided, it will not be rendered. | null |
textAlignment | TextAlignmentEnum | Text alignment inside the component: left, center or right. This prop is ignored if isFullModeStyle is true. | "left" |
textMode | TextModeEnum | Text mode used to process the text from headline and subhead props. | "html" |
textPosition | TextPositionEnum | Position of the text component: left, center or right. | "left" |
TextPositionEnum possible values
| Enum name | Enum value | Description |
|---|
| Left | 'left' | Text will be to the left. If isFullModeStyle is false, image will be on the right. |
| Center | 'center' | Text will be in the center. Not applicable if isFullModeStyle is false. |
| Right | 'right' | Text will be to the right. If isFullModeStyle is false, image will be on the left. |
CallToActionEnum possible values
| Enum name | Enum value | Description |
|---|
| None | none | Doesn't render any call-to-action component. |
| Button | button | Renders the call-to-action component as a button. |
| Link | link | Renders the call-to-action component as a text in a link format. |
LinkTargetEnum possible values
These values are the same ones supported by HTML5 anchor tags. For more information, refer to MDN documentation.
| Enum name | Enum value | Description |
|---|
| Self (default) | _self | Opens the link in the current browsing context. |
| Blank | _blank | Opens the link in a new tab, but users can configure browsers to open a new window instead. |
| Parent | _parent | Opens the link in the parent browsing context of the current one. If no parent, behaves as _self. |
| Top | _top | Opens the link in the topmost browsing context (the "highest" context that’s an ancestor of the current one). If no ancestors, behaves as _self. |
TextModeEnum possible values
| Enum name | Enum value | Description |
|---|
| HTML | html | Uses HTML text for headline and subhead props. |
| Rich-Text | rich-text | Uses markdown text and the rich-text block for headline and subhead props. |
Customization
To apply CSS customizations in this and other blocks, follow the Using CSS handles for store customization guide.
| CSS Handles |
|---|
infoCardCallActionContainer |
infoCardCallActionText |
infoCardContainer |
infoCardHeadline |
infoCardImage |
infoCardImageContainer |
infoCardImageLinkWrapper |
infoCardSubhead |
infoCardTextContainer |
