SXA Storefront shared events

CXAEvent.ClearMessage

Requests the Message Summary rendering to remove messages that are displayed.

Listening

Emitting

CXAEvent.SendMessage

Requests the Message Summary rendering to display the message.

Event argument:

{
  type:
CXAMessageType,
  message: String
}

CXAMessageType enum:

Listening

Emitting

CXAEvent.CartUpdated

Emits the event when the latest cart is received. This event is emitted by the CXACartContext whenever the object received by the context is of type CartJsonResult.

Listening

Emitting

CXAEvent.SetPrice

Requests the Product Price rendering to display the price of the current product variant or product bundle selection.

Event argument:

{
  productId: String,
  listPrice: Number,
  adjustedPrice:
Number,
  isOnSale: Boolean,
  savingsMessage:
String
}

Listening

Emitting

CXAEvent.SelectedProduct

Emits an event when a product variant is selected.

Event argument:
{
  CurrentCatalogName:
String,
  CurrentProductId:
String,
  CurrentVariantId:
String
}

Listening

Emitting

CXAEvent.SelectedBundleProduct

Emits an event when a product bundle is selected.

Event argument:

{
  bundleSelection:
BundleSelection
}

Listening

Emitting

CXAEvent.SelectedProductValid

Emits the event to indicate that the current product selection is valid so that the Add to Cart component can enable the Add to Cart button.

Listening

Emitting

CXAEvent.SelectedProductInvalid

Emits the event to indicate that the current product selection is valid so that the Add to Cart component can disable the Add to Cart button.

Listening

Emitting

CXAEvent.BundleStockStatusValid

Emits the event to indicate that the current bundle selection’s stock status is valid so that the Product Bundle can then request for the Bundle Selection’s price.

Event argument:

{
  productId: String
}

Listening

Emitting

CXAEvent.GetStockInfo

Product Inventory component emits this event when the response is received from the API endpoint Catalog/GetCurrentProductStockInfo.

Event argument:

{
  productId: String,
  stockInfos: Array
}

Listening

Emitting

CXAEvent.DiscountApplied

CXACartContext emits the event after calling to the API endpoint Cart/ApplyDiscount.

Listening

Emitting

CXAEvent.DiscountRemoved

CXACartContext emits the event after calling to the API endpoint Cart/RemoveDiscount.

Listening

Emitting