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 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 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 TaxContent from "../commerce-modules/tax/admin-widget-zones/_content.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 />
### Shipping Option Type Pages
<ShippingOptionTypeContent />
### Shipping Profile Pages
<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 = {
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.
## Shipping Option Type Pages
<ShippingOptionTypeContent />
## Shipping Profile Pages
<ShippingProfileContent />