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
- Import the app to your theme's dependencies in
manifest.json
, for example:
_10 "dependencies": {_10 // ..._10 "vtex.challenge-tp-condition": "0.x"_10 }
- Add the
challenge.trade-policy-condition
block as aparent
block to the templates of the pages you want to protect, such as:
_13 "store.home": {_13 "blocks": [_13 "shelf#home",_13 "flex-layout.row#deals",_13 "info-card#home",_13 "rich-text#question",_13 "rich-text#link",_13 "newsletter"_13 ],_13+ "parent": {_13+ "challenge": "challenge.trade-policy-condition"_13+ }_13 },
- 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:
_10"challenge.trade-policy-condition": {_10 "props": {_10 "redirectPath": "/login"_10 }_10},
Prop name | Type | Description | Default value |
---|---|---|---|
redirectPath | string | Path to which the not logged in user will be redirected | /login |
forbiddenRedirectPath | string | Path to which the logged in user will be redirected if not allowed access according to the Condition Rule | /login |
defaultContentVisibility | enum | Whether the store's content should be visible (visible ) or hidden (hidden ) while the Challenge block is verifying the user's access permission | visible |
: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.