VTEX Developer Portal

Challenge Trade Policy Condition

📢 Use this project, contribute to it or open issues to help evolve it using Store Discussion.

Challenge Trade Policy Condition

All ContributorsAll Contributors

Used in B2B environments, the Challenge block is a non-rendered block responsible for checking if a user is allowed to access the store's content.

:information_source: This check is made according to the Condition Rule specified in the Trade Policy configuration, one of the steps needed to configure a B2B environment in VTEX IO.

Configuration

  1. Import the app to your theme's dependencies in manifest.json, for example:
"dependencies": {
    // ...
    "vtex.challenge-tp-condition": "0.x"
  }
  1. Add the challenge.trade-policy-condition block as a parent block to the templates of the pages you want to protect, such as:
"store.home": {
   "blocks": [
     "shelf#home",
     "flex-layout.row#deals",
     "info-card#home",
     "rich-text#question",
     "rich-text#link",
     "newsletter"
   ],
+   "parent": {
+     "challenge": "challenge.trade-policy-condition"
+   }
 },
  1. Declare the challenge.trade-policy-condition, using its props to define to where the store's users should be redirected according to each scenario. For example:
"challenge.trade-policy-condition": {
  "props": {
    "redirectPath": "/login"
  }
},
Prop nameTypeDescriptionDefault value
redirectPathstringPath to which the not logged in user will be redirected/login
forbiddenRedirectPathstringPath to which the logged in user will be redirected if not allowed access according to the Condition Rule/login
defaultContentVisibilityenumWhether the store's content should be visible (visible) or hidden (hidden) while the Challenge block is verifying the user's access permissionvisible

:warning: Using hidden as the defaultContentVisibility value result in the entire page's content being rendered on the client side (in a scenario in which the check concludes that the user has permission to access the store). The page will not be Server Side Rendered (SSR) due to the fact that this verification process is user-based, making it impossible to cache.

Customization

No CSS Handles are available for the app customization.

Contributors ✨

Thanks goes to these wonderful people:

This project follows the all-contributors specification. Contributions of any kind are welcome!

Updated 5 months ago


Challenge Trade Policy Condition


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.