Documentation
Feedback
Guides

Notification

The notification component displays text content in a bar style (notification.bar) or inline (notification.inline). This Component can be imported and used by any VTEX app.

{"base64":"  ","img":{"width":1888,"height":733,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":1082858,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-components-notification-0.png"}}

Configuration

  1. Import the vtex.store-components app to your theme's dependencies in the manifest.json file as in the following example:

_10
"dependencies": {
_10
"vtex.store-components": "3.x"
_10
}

  1. Add the notification block to any template of your choice. For example:

_10
"store.home": {
_10
"blocks": [
_10
+ "notification.bar",
_10
"carousel#home",
_10
"shelf#home"
_10
]
_10
},

  1. Then, declare the notification block using the props stated in the Props table.

Props

Prop nameTypeDescriptionDefault value
contentStringText to be used in the bar.''
classesCustomCSSClassesOverrides default CSS handles. To better understand how this prop works, check this document. Note that this is only helpful if you're using this block as a React component.undefined

Customization

To apply CSS customizations in this and other blocks, follow the Using CSS handles for store customization guide.

CSS Handles
notificationBarContainer
notificationBarInner
notificationContent
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page