docs: added shipping option type injection zones (#13332)

* docs: added shipping option type injection zones

* added note
This commit is contained in:
Shahed Nasser
2025-08-28 20:09:06 +03:00
committed by GitHub
parent 5c6e172c61
commit 137a74c1f4
5 changed files with 113 additions and 4 deletions
@@ -18,7 +18,8 @@ import RegionContent from "../commerce-modules/region/admin-widget-zones/_conten
import ReservationContent from "../commerce-modules/inventory/admin-widget-zones/_content/reservation.mdx" import ReservationContent from "../commerce-modules/inventory/admin-widget-zones/_content/reservation.mdx"
import ReturnReasonContent from "../commerce-modules/order/admin-widget-zones/_content/return-reason.mdx" import ReturnReasonContent from "../commerce-modules/order/admin-widget-zones/_content/return-reason.mdx"
import SalesChannelContent from "../commerce-modules/sales-channel/admin-widget-zones/_content.mdx" import SalesChannelContent from "../commerce-modules/sales-channel/admin-widget-zones/_content.mdx"
import ShippingProfileContent from "../commerce-modules/fulfillment/admin-widget-zones/_content.mdx" import ShippingProfileContent from "../commerce-modules/fulfillment/admin-widget-zones/_content/shipping-profile.mdx"
import ShippingOptionTypeContent from "../commerce-modules/fulfillment/admin-widget-zones/_content/shipping-option-type.mdx"
import StoreContent from "../commerce-modules/store/admin-widget-zones/_content.mdx" import StoreContent from "../commerce-modules/store/admin-widget-zones/_content.mdx"
import TaxContent from "../commerce-modules/tax/admin-widget-zones/_content.mdx" import TaxContent from "../commerce-modules/tax/admin-widget-zones/_content.mdx"
import UserContent from "../commerce-modules/user/admin-widget-zones/_content/user.mdx" import UserContent from "../commerce-modules/user/admin-widget-zones/_content/user.mdx"
@@ -133,6 +134,10 @@ This documentation page includes the list of injection zones you can add Admin W
<SalesChannelContent /> <SalesChannelContent />
### Shipping Option Type Pages
<ShippingOptionTypeContent />
### Shipping Profile Pages ### Shipping Profile Pages
<ShippingProfileContent /> <ShippingProfileContent />
@@ -0,0 +1,99 @@
import { Table } from "docs-ui"
<Note>
The following injection zones are available from [Medusa v2.10.0](https://github.com/medusajs/medusa/releases/tag/v2.10.0)
</Note>
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell className="w-1/3">Injection Zone Name</Table.HeaderCell>
<Table.HeaderCell className="w-1/3">Description</Table.HeaderCell>
<Table.HeaderCell className="w-1/3">Additional Props</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`shipping_option_type.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the shipping option types list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping_option_type.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the shipping option types list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping_option_type.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a shipping option type's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminShippingOptionType>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminShippingOptionType object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping_option_type.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a shipping option type's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminShippingOptionType>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminShippingOptionType object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -1,4 +1,5 @@
import ShippingProfileContent from "./_content.mdx" import ShippingProfileContent from "./_content/shipping-profile.mdx"
import ShippingOptionTypeContent from "./_content/shipping-option-type.mdx"
export const metadata = { export const metadata = {
title: `Fulfillment Module's Admin Widget Injection Zones`, title: `Fulfillment Module's Admin Widget Injection Zones`,
@@ -8,6 +9,10 @@ export const metadata = {
This reference shows all the injection zones in the Medusa Admin related to the Fulfillment Module. This reference shows all the injection zones in the Medusa Admin related to the Fulfillment Module.
## Shipping Option Type Pages
<ShippingOptionTypeContent />
## Shipping Profile Pages ## Shipping Profile Pages
<ShippingProfileContent /> <ShippingProfileContent />
+2 -2
View File
@@ -214,7 +214,7 @@ export const generatedEditDates = {
"app/infrastructure-modules/file/page.mdx": "2025-04-17T08:29:00.672Z", "app/infrastructure-modules/file/page.mdx": "2025-04-17T08:29:00.672Z",
"app/infrastructure-modules/event/page.mdx": "2025-04-17T08:29:00.488Z", "app/infrastructure-modules/event/page.mdx": "2025-04-17T08:29:00.488Z",
"app/infrastructure-modules/cache/create/page.mdx": "2025-03-27T14:53:13.309Z", "app/infrastructure-modules/cache/create/page.mdx": "2025-03-27T14:53:13.309Z",
"app/admin-widget-injection-zones/page.mdx": "2024-12-24T08:48:36.154Z", "app/admin-widget-injection-zones/page.mdx": "2025-08-28T16:47:14.680Z",
"app/infrastructure-modules/notification/page.mdx": "2025-06-25T10:48:23.838Z", "app/infrastructure-modules/notification/page.mdx": "2025-06-25T10:48:23.838Z",
"app/infrastructure-modules/event/create/page.mdx": "2025-03-27T14:53:13.309Z", "app/infrastructure-modules/event/create/page.mdx": "2025-03-27T14:53:13.309Z",
"references/core_flows/Order/functions/core_flows.Order.orderEditUpdateItemQuantityValidationStep/page.mdx": "2024-08-20T00:10:58.913Z", "references/core_flows/Order/functions/core_flows.Order.orderEditUpdateItemQuantityValidationStep/page.mdx": "2024-08-20T00:10:58.913Z",
@@ -5693,7 +5693,7 @@ export const generatedEditDates = {
"app/commerce-modules/api-key/admin-widget-zones/page.mdx": "2024-12-24T08:29:56.989Z", "app/commerce-modules/api-key/admin-widget-zones/page.mdx": "2024-12-24T08:29:56.989Z",
"app/commerce-modules/auth/admin-widget-zones/page.mdx": "2024-12-24T08:11:08.250Z", "app/commerce-modules/auth/admin-widget-zones/page.mdx": "2024-12-24T08:11:08.250Z",
"app/commerce-modules/customer/admin-widget-zones/page.mdx": "2024-12-24T08:07:15.439Z", "app/commerce-modules/customer/admin-widget-zones/page.mdx": "2024-12-24T08:07:15.439Z",
"app/commerce-modules/fulfillment/admin-widget-zones/page.mdx": "2024-12-24T08:45:36.216Z", "app/commerce-modules/fulfillment/admin-widget-zones/page.mdx": "2025-08-28T16:47:19.790Z",
"app/commerce-modules/inventory/admin-widget-zones/page.mdx": "2024-12-24T08:42:14.732Z", "app/commerce-modules/inventory/admin-widget-zones/page.mdx": "2024-12-24T08:42:14.732Z",
"app/commerce-modules/order/admin-widget-zones/page.mdx": "2024-12-24T08:43:41.179Z", "app/commerce-modules/order/admin-widget-zones/page.mdx": "2024-12-24T08:43:41.179Z",
"app/commerce-modules/pricing/admin-widget-zones/page.mdx": "2024-12-24T08:13:03.740Z", "app/commerce-modules/pricing/admin-widget-zones/page.mdx": "2024-12-24T08:13:03.740Z",