Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 2.45 KB

Notification.md

File metadata and controls

61 lines (45 loc) · 2.45 KB

Notification

Description

Notification is a VTEX component allows you to display a text content in a bar style or inline. This Component can be imported and used by any VTEX app.

📢 Disclaimer: Don't fork this project; use, contribute, or open issue with your feature request.

Table of Contents

Usage

You should follow the usage instruction in the main README.

notification.bar and notification.inline is a block allowed in the [store] interface(https://github.com/vtex-apps/store).

You can use it by adding it to the blocks of your store sections, for example:

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

Blocks API

When implementing this component as a block, various inner blocks may be available. For now this block does not have any required or optional blocks.

Configuration

Through the Storefront, you can change the Notification's behavior and interface. However, you also can make in your theme app, as Store theme does.

Prop name Type Description Default value
content String Text to be used in the bar. ''
classes CustomCSSClasses Used to override default CSS handles. To better understand how this prop works, we recommend reading about it here. Note that this is only useful if you're using this block as a React component. undefined

Styles API

You should follow the Styles API instruction in the main README.

CSS Namespaces

Below, we describe the namespace that are defined in the Notification.

Class name Description Component Source
notificationContent The content of Notification index
notificationBarContainer The main container of NotificationBar index
notificationBarInner The inner container of NotificationBar index