Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit readme to include forced overrides functionability #2233

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 44 additions & 12 deletions packages/extension-chakra-storefront/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,18 +107,50 @@ Please refer to the sample configuration below in order to properly configure yo
"isProduction": false
},
"enabled": true, // Toggle this extension on or off, this is useful for debugging and development, defaults to true.
"pages": { // Define the url path of each page. A page can be set to false if you want to disable it.
"Account": "/account",
"Cart": "/cart",
"Checkout": "/checkout",
"CheckoutConfirmation": "/checkout/confirmation/:orderNo",
"Home": "/",
"Login": "/login",
"Registration": "/registration",
"ResetPassword": "/reset-password",
"LoginRedirect": "/callback",
"ProductDetail": "/product/:productId",
"ProductList": ["/search", "/category/:categoryId"]
"pages": { // Define the url path of and the configuration on each page. A page can be set to false if you want to disable it.
"Account": {
"path": "/account",
"orderSearchParam": {"limit": 10, "offset": 0, "sort": "best-matches", "refine": []}
},
"Cart": {
"path": "/cart"
},
"Checkout": {
"path": "/checkout",
"shippingCountryCode": [
{"value": "CA", "label": "Canada"},
{"value": "US", "label": "United States"}
]
},
"CheckoutConfirmation": {
"path": "/checkout/confirmation/:orderNo"
},
"Home": {
"path": "/",
"productLimit": 10,
"mainCategory": "newarrivals"
},
"Login": {
"path": "/login"
},
"Registration": {
"path": "/registration"
},
"ResetPassword": {
"path": "/reset-password"
},
"LoginRedirect": {
"path": "/callback"
},
"ProductDetail": {
"path": "/product/:productId"
},
"ProductList": {
"path": ["/search", "/category/:categoryId"],
"imageViewType": "large",
"selectableAttributeId": "color",
"filterAccordionSate": "filters-expanded-index"
}
},
"siteAliases": {}, // Site alias's for multi-site support.
"sites": [ // Site configs for multi-site support.
Expand Down
9 changes: 8 additions & 1 deletion packages/pwa-kit-extension-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,13 @@ Now when the base application is built the import for the `logo.ts` in `extensio

This mechanism is useful when you want to allow for fine grained customization of your application extension. Its the responsibility of the extension developer to ensure their document what files are overridable and what the expected input and output of those files are. For example, if the overridable file is a React component you should document the props that get passed to that component and the expected exports of the file.

#### Forced Overrides
Users of your extension may sometimes need to override files that are not explicitly designed to be overridden. To accommodate this, they can use a special dotfile named `.forced_overrides`.

This file, located at the root of their project, should contain a list of files they wish to override, prefixed with the extension package name. Any files listed in `.forced_overrides` will be treated as overridable, bypassing standard restrictions.

Note: It is advisable to use this function with caution since it could potentially break intended behavior of installed extensions. This should be used as a temporary solution to urgently patch/update an extension.

#### Setup App and Setup Server

These two files represent the core of your extension implementation and how your extension is able to enhance and integrate into your PWA-Kit Application. In your generated extension you'll find that we have stubbed each file out for you with implementations for each Application Extensibility integration point. You can choose to change the implementation of these methods to suit the needs of your extensions, or you can leave them as is if your extension does not require them.
Expand Down Expand Up @@ -280,4 +287,4 @@ export default useStoreLocatorState
```

## Support Policy
Security patches are provided for 24 months after the general availability of each major version of the SDK (1.0, 2.0, and so on).
Security patches are provided for 24 months after the general availability of each major version of the SDK (1.0, 2.0, and so on).
Loading