Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 3.78 KB

README.md

File metadata and controls

72 lines (51 loc) · 3.78 KB
Raw

Availability Subscriber

Description

AvailabilitySubscriber is a VTEX Component that shows the availability subscriber form that is shown when the product isn't available. 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.

Then, add availability-subscriber block into your app theme, as we do in our Product Details app.

Blocks API

When implementing this component as a block, various inner blocks may be available. The following interface lists the available blocks within AvailabilitySubscriber and describes if they are required or optional.

  "availability-subscriber": {
    "component": "AvailabilitySubscriber"
  }

For now this block does not have any required or optional blocks.

Configuration

🚧 🚧 🚧

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 AvailabilitySubscriber.

Class name Description Component Source
subscriberContainer AvailabilitySubscriber container index
title AvailabilitySubscriber title index
subscribeLabel AvailabilitySubscriber subscribe label index
form AvailabilitySubscriber form container index
content AvailabilitySubscriber form content container index
input AvailabilitySubscriber form input containter index
inputName AvailabilitySubscriber form input name index
inputEmail AvailabilitySubscriber form input email index
submit AvailabilitySubscriber form submit button index
success AvailabilitySubscriber success feedback message index
error AvailabilitySubscriber error feedback message index

Data

The form is submitted to Master Data on the Entity: AS

Prop name Description
skuId The id of the product sku to which will be watched for changes in the product quantity
name The name of the user
email The email of the user
notificationSend If the notification has been sent already
createdAt When the document was created
sendAt When the user was notificated