diff --git a/www/apps/resources/app/admin-widget-injection-zones/page.mdx b/www/apps/resources/app/admin-widget-injection-zones/page.mdx index 4d61b618f8..78768abb31 100644 --- a/www/apps/resources/app/admin-widget-injection-zones/page.mdx +++ b/www/apps/resources/app/admin-widget-injection-zones/page.mdx @@ -8,6 +8,474 @@ export const metadata = { This documentation page includes the list of injection zones you can add Admin Widgets to. +## Campaign Pages + + + + + Injection Zone Name + Description + Additional Props + + + + + + + `campaign.list.before` + + + + + Added at the top of the campaigns list page. + + + + + \- + + + + + + + `campaign.list.after` + + + + + Added at the bottom of the campaigns list page. + + + + + \- + + + + + + + `campaign.details.before` + + + + + Added at the top of a campaign's details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminCampaign object + } + ``` + + + + + + + `campaign.details.after` + + + + + Added at the bottom of a campaign's details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminCampaign object + } + ``` + + + + + + + `campaign.details.side.before` + + + + + Added at the top of the second column in the campaign details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminCampaign object + } + ``` + + + + + + + `campaign.details.side.after` + + + + + Added at the bottom of the second column in the campaign details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminCampaign object + } + ``` + + + + +
+ +## Customer Pages + + + + + Injection Zone Name + Description + Additional Props + + + + + + + `customer.list.before` + + + + + Added at the top of the customers list page. + + + + + \- + + + + + + + `customer.list.after` + + + + + Added at the bottom of the customers list page. + + + + + \- + + + + + + + `customer.details.before` + + + + + Added at the top of the customer details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminCustomer object + } + ``` + + + + + + + `customer.details.after` + + + + + Added at the bottom of the customer details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminCustomer object + } + ``` + + + + +
+ +## Customer Group Pages + + + + + Injection Zone Name + Description + Additional Props + + + + + + + `customer_group.list.before` + + + + + Added at the top of the customer groups list page. + + + + + \- + + + + + + + `customer_group.list.after` + + + + + Added at the bottom of the customer groups list page. + + + + + \- + + + + + + + `customer_group.details.before` + + + + + Added at the top of the customer group details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminCustomerGroup object + } + ``` + + + + + + + `customer_group.details.after` + + + + + Added at the bottom of the customer group details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminCustomerGroup object + } + ``` + + + + +
+ +## Inventory Pages + + + + + Injection Zone Name + Description + Additional Props + + + + + + + `inventory_item.list.before` + + + + + Added at the top of the inventory list page. + + + + + \- + + + + + + + `inventory_item.list.after` + + + + + Added at the bottom of the inventory list page. + + + + + \- + + + + + + + `inventory_item.details.before` + + + + + Added at the top of the inventory item details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminInventoryItem object + } + ``` + + + + + + + `inventory_item.details.after` + + + + + Added at the bottom of the inventory item details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminInventoryItem object + } + ``` + + + + + + + `inventory_item.details.side.before` + + + + + Added at the top of the second column in the inventory item details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminInventoryItem object + } + ``` + + + + + + + `inventory_item.details.side.after` + + + + + Added at the end of the second column in the inventory item details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminInventoryItem object + } + ``` + + + + +
+ ## Login Page @@ -173,7 +641,7 @@ This documentation page includes the list of injection zones you can add Admin W - `order.details.side.before` + `order.details.side.after` @@ -196,7 +664,7 @@ This documentation page includes the list of injection zones you can add Admin W
-## Customer Pages +## Price List Pages @@ -210,12 +678,12 @@ This documentation page includes the list of injection zones you can add Admin W - `customer.list.before` + `price_list.list.before` - Added at the top of the customers list page. + Added at the top of the Pricing list page. @@ -227,12 +695,12 @@ This documentation page includes the list of injection zones you can add Admin W - `customer.list.after` + `price_list.list.after` - Added at the bottom of the customers list page. + Added at the bottom of the Pricing list page. @@ -244,21 +712,21 @@ This documentation page includes the list of injection zones you can add Admin W - `customer.details.before` + `price_list.details.before` - Added at the top of the customer details page. + Added at the top of a price list's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminCustomer object + data, // AdminPriceList object } ``` @@ -267,21 +735,21 @@ This documentation page includes the list of injection zones you can add Admin W - `customer.details.after` + `price_list.details.after` - Added at the bottom of the customer details page. + Added at the bottom of a price list's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminCustomer object + data, // AdminPriceList object } ``` @@ -290,55 +758,21 @@ This documentation page includes the list of injection zones you can add Admin W - `customer_group.list.before` + `price_list.details.side.before` - Added at the top of the customer groups list page. - - - - - \- - - - - - - - `customer_group.list.after` - - - - - Added at the bottom of the customer groups list page. - - - - - \- - - - - - - - `customer_group.details.before` - - - - - Added at the top of the customer group details page. + Added at the top of the second column in the price list details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminCustomerGroup object + data, // AdminPriceList object } ``` @@ -347,21 +781,21 @@ This documentation page includes the list of injection zones you can add Admin W - `customer_group.details.after` + `price_list.details.side.after` - Added at the bottom of the customer group details page. + Added at the bottom of the second column in the price list details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminCustomerGroup object + data, // AdminPriceList object } ``` @@ -507,6 +941,20 @@ This documentation page includes the list of injection zones you can add Admin W + +
+ +## Product Collection Pages + + + + + Injection Zone Name + Description + Additional Props + + + @@ -587,6 +1035,20 @@ This documentation page includes the list of injection zones you can add Admin W + +
+ +## Product Category Pages + + + + + Injection Zone Name + Description + Additional Props + + + @@ -716,145 +1178,7 @@ This documentation page includes the list of injection zones you can add Admin W
-## Pricing Pages - - - - Injection Zone Name - Description - Additional Props - - - - - - - `price_list.list.before` - - - - - Added at the top of the Pricing list page. - - - - - \- - - - - - - - `price_list.list.after` - - - - - Added at the bottom of the Pricing list page. - - - - - \- - - - - - - - `price_list.details.before` - - - - - Added at the top of a price list's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminPriceList object - } - ``` - - - - - - - `price_list.details.after` - - - - - Added at the bottom of a price list's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminPriceList object - } - ``` - - - - - - - `price_list.details.side.before` - - - - - Added at the top of the second column in the price list details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminPriceList object - } - ``` - - - - - - - `price_list.details.side.after` - - - - - Added at the bottom of the second column in the price list details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminPriceList object - } - ``` - - - - -
## Promotion Pages @@ -993,138 +1317,12 @@ This documentation page includes the list of injection zones you can add Admin W - - - - `campaign.list.before` - - - - - Added at the top of the campaigns list page. - - - - - \- - - - - - - - `campaign.list.after` - - - - - Added at the bottom of the campaigns list page. - - - - - \- - - - - - - - `campaign.details.before` - - - - - Added at the top of a campaign's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminCampaign object - } - ``` - - - - - - - `campaign.details.after` - - - - - Added at the bottom of a campaign's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminCampaign object - } - ``` - - - - - - - `campaign.details.side.before` - - - - - Added at the top of the second column in the campaign details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminCampaign object - } - ``` - - - - - - - `campaign.details.side.after` - - - - - Added at the bottom of the second column in the campaign details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminCampaign object - } - ``` - - - ## Setting Pages -### User Pages +### API Key Pages @@ -1138,12 +1336,12 @@ This documentation page includes the list of injection zones you can add Admin W - `user.list.before` + `api_key.list.before` - Added at the top of the users list page. + Added at the top of the API keys list page. @@ -1155,12 +1353,12 @@ This documentation page includes the list of injection zones you can add Admin W - `user.list.after` + `api_key.list.after` - Added at the bottom of the users list page. + Added at the bottom of the API keys list page. @@ -1172,21 +1370,21 @@ This documentation page includes the list of injection zones you can add Admin W - `user.details.before` + `api_key.details.before` - Added at the top of a user's details page. + Added at the top of a API key's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminUser object + data, // AdminApiKey object } ``` @@ -1195,21 +1393,21 @@ This documentation page includes the list of injection zones you can add Admin W - `user.details.after` + `api_key.details.after` - Added at the bottom of a user's details page. + Added at the bottom of a API key's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminUser object + data, // AdminApiKey object } ``` @@ -1218,7 +1416,7 @@ This documentation page includes the list of injection zones you can add Admin W
-### Store Pages +### Location Pages @@ -1232,21 +1430,55 @@ This documentation page includes the list of injection zones you can add Admin W - `store.details.before` + `location.list.before` - Added at the top of a store's details page. + Added at the top of the locations list page. + + + + + \- + + + + + + + `location.list.after` + + + + + Added at the bottom of the locations list page. + + + + + \- + + + + + + + `location.details.before` + + + + + Added at the top of a location's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminStore object + data, // AdminStockLocation object } ``` @@ -1255,21 +1487,67 @@ This documentation page includes the list of injection zones you can add Admin W - `store.details.after` + `location.details.after` - Added at the bottom of a store's details page. + Added at the bottom of a location's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminStore object + data, // AdminStockLocation object + } + ``` + + + + + + + `location.details.side.before` + + + + + Added at the top of the second column in the location details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminStockLocation object + } + ``` + + + + + + + `location.details.side.after` + + + + + Added at the bottom of the second column in the location details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminStockLocation object } ``` @@ -1432,334 +1710,6 @@ This documentation page includes the list of injection zones you can add Admin W
-### Shipping Profile Pages - - - - - Injection Zone Name - Description - Additional Props - - - - - - - `shipping_profile.list.before` - - - - - Added at the top of the shipping profiles list page. - - - - - \- - - - - - - - `shipping_profile.list.after` - - - - - Added at the bottom of the shipping profiles list page. - - - - - \- - - - - - - - `shipping_profile.details.before` - - - - - Added at the top of a shipping profile's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminShippingProfile object - } - ``` - - - - - - - `shipping_profile.details.after` - - - - - Added at the bottom of a shipping profile's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminShippingProfile object - } - ``` - - - - -
- -### Location Pages - - - - - Injection Zone Name - Description - Additional Props - - - - - - - `location.list.before` - - - - - Added at the top of the locations list page. - - - - - \- - - - - - - - `location.list.after` - - - - - Added at the bottom of the locations list page. - - - - - \- - - - - - - - `location.details.before` - - - - - Added at the top of a location's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminStockLocation object - } - ``` - - - - - - - `location.details.after` - - - - - Added at the bottom of a location's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminStockLocation object - } - ``` - - - - - - - `location.details.side.before` - - - - - Added at the top of the second column in the location details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminStockLocation object - } - ``` - - - - - - - `location.details.side.after` - - - - - Added at the bottom of the second column in the location details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminStockLocation object - } - ``` - - - - -
- -### Sales Channel Pages - - - - - Injection Zone Name - Description - Additional Props - - - - - - - `sales_channel.list.before` - - - - - Added at the top of the sales channels list page. - - - - - \- - - - - - - - `sales_channel.list.after` - - - - - Added at the bottom of the sales channels list page. - - - - - \- - - - - - - - `sales_channel.details.before` - - - - - Added at the top of a sales channel's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminSalesChannel object - } - ``` - - - - - - - `sales_channel.details.after` - - - - - Added at the bottom of a sales channel's details page. - - - - - Type `DetailWidgetProps` imported from `@medusajs/framework/types` - - ```ts blockStyle="inline" - { - data, // AdminSalesChannel object - } - ``` - - - - -
- ### Reservation Pages @@ -1900,7 +1850,7 @@ This documentation page includes the list of injection zones you can add Admin W
-### API Key Pages +### Return Reason Pages @@ -1914,12 +1864,12 @@ This documentation page includes the list of injection zones you can add Admin W - `api_key.list.before` + `return_reason.list.before` - Added at the top of the API keys list page. + Added at the top of the return reasons list page. @@ -1931,12 +1881,43 @@ This documentation page includes the list of injection zones you can add Admin W - `api_key.list.after` + `return_reason.list.after` - Added at the bottom of the API keys list page. + Added at the bottom of the return reasons list page. + + + + + \- + + + + +
+ +### Sales Channel Pages + + + + + Injection Zone Name + Description + Additional Props + + + + + + + `sales_channel.list.before` + + + + + Added at the top of the sales channels list page. @@ -1948,21 +1929,38 @@ This documentation page includes the list of injection zones you can add Admin W - `api_key.details.before` + `sales_channel.list.after` - Added at the top of a API key's details page. + Added at the bottom of the sales channels list page. + + + + + \- + + + + + + + `sales_channel.details.before` + + + + + Added at the top of a sales channel's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminApiKey object + data, // AdminSalesChannel object } ``` @@ -1971,21 +1969,21 @@ This documentation page includes the list of injection zones you can add Admin W - `api_key.details.after` + `sales_channel.details.after` - Added at the bottom of a API key's details page. + Added at the bottom of a sales channel's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminApiKey object + data, // AdminSalesChannel object } ``` @@ -1994,7 +1992,7 @@ This documentation page includes the list of injection zones you can add Admin W
-### Workflow Pages +### Shipping Profile Pages @@ -2008,12 +2006,12 @@ This documentation page includes the list of injection zones you can add Admin W - `workflow.list.before` + `shipping_profile.list.before` - Added at the top of the workflows list page. + Added at the top of the shipping profiles list page. @@ -2025,12 +2023,12 @@ This documentation page includes the list of injection zones you can add Admin W - `workflow.list.after` + `shipping_profile.list.after` - Added at the bottom of the workflows list page. + Added at the bottom of the shipping profiles list page. @@ -2042,21 +2040,21 @@ This documentation page includes the list of injection zones you can add Admin W - `workflow.details.before` + `shipping_profile.details.before` - Added at the top of a workflow execution's details page. + Added at the top of a shipping profile's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminWorkflowExecution object + data, // AdminShippingProfile object } ``` @@ -2065,21 +2063,81 @@ This documentation page includes the list of injection zones you can add Admin W - `workflow.details.after` + `shipping_profile.details.after` - Added at the bottom of a workflow execution's details page. + Added at the bottom of a shipping profile's details page. - Type `DetailWidgetProps` imported from `@medusajs/framework/types` + Type `DetailWidgetProps` imported from `@medusajs/framework/types` ```ts blockStyle="inline" { - data, // AdminWorkflowExecution object + data, // AdminShippingProfile object + } + ``` + + + + +
+ +### Store Pages + + + + + Injection Zone Name + Description + Additional Props + + + + + + + `store.details.before` + + + + + Added at the top of a store's details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminStore object + } + ``` + + + + + + + `store.details.after` + + + + + Added at the bottom of a store's details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminStore object } ``` @@ -2181,3 +2239,191 @@ This documentation page includes the list of injection zones you can add Admin W
+ +### User Pages + + + + + Injection Zone Name + Description + Additional Props + + + + + + + `user.list.before` + + + + + Added at the top of the users list page. + + + + + \- + + + + + + + `user.list.after` + + + + + Added at the bottom of the users list page. + + + + + \- + + + + + + + `user.details.before` + + + + + Added at the top of a user's details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminUser object + } + ``` + + + + + + + `user.details.after` + + + + + Added at the bottom of a user's details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminUser object + } + ``` + + + + +
+ +### Workflow Pages + + + + + Injection Zone Name + Description + Additional Props + + + + + + + `workflow.list.before` + + + + + Added at the top of the workflows list page. + + + + + \- + + + + + + + `workflow.list.after` + + + + + Added at the bottom of the workflows list page. + + + + + \- + + + + + + + `workflow.details.before` + + + + + Added at the top of a workflow execution's details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminWorkflowExecution object + } + ``` + + + + + + + `workflow.details.after` + + + + + Added at the bottom of a workflow execution's details page. + + + + + Type `DetailWidgetProps` imported from `@medusajs/framework/types` + + ```ts blockStyle="inline" + { + data, // AdminWorkflowExecution object + } + ``` + + + + +
diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs index f790a68300..15e13414f6 100644 --- a/www/apps/resources/generated/edit-dates.mjs +++ b/www/apps/resources/generated/edit-dates.mjs @@ -233,7 +233,7 @@ export const generatedEditDates = { "app/architectural-modules/file/page.mdx": "2024-07-01T10:21:19+03:00", "app/architectural-modules/event/page.mdx": "2024-05-28T13:25:03+03:00", "app/architectural-modules/cache/create/page.mdx": "2024-10-16T08:51:35.074Z", - "app/admin-widget-injection-zones/page.mdx": "2024-09-30T08:43:53.147Z", + "app/admin-widget-injection-zones/page.mdx": "2024-11-14T15:10:36.495Z", "app/architectural-modules/notification/page.mdx": "2024-10-15T12:51:28.735Z", "app/architectural-modules/event/create/page.mdx": "2024-11-12T11:54:51.583Z", "references/core_flows/Order/functions/core_flows.Order.orderEditUpdateItemQuantityValidationStep/page.mdx": "2024-08-20T00:10:58.913Z", diff --git a/www/apps/resources/providers/index.tsx b/www/apps/resources/providers/index.tsx index ae55b911c5..79bd672a1f 100644 --- a/www/apps/resources/providers/index.tsx +++ b/www/apps/resources/providers/index.tsx @@ -34,7 +34,7 @@ const Providers = ({ children }: ProvidersProps) => { {children}