docs: split admin widget zone to pages (#10719)

This commit is contained in:
Shahed Nasser
2024-12-24 12:29:41 +02:00
committed by GitHub
parent fd1afa8bc9
commit 041baafd38
57 changed files with 2992 additions and 2357 deletions
@@ -0,0 +1,139 @@
import { Table } from "docs-ui"
<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>
`order.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the orders list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the order list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of the order details page
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminOrder object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.details.after`
</Table.Cell>
<Table.Cell>
Added at the end of the order details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminOrder object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the order details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminOrder object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the end of the second column in the order details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminOrder object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -0,0 +1,47 @@
import { Table } from "docs-ui"
<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>
`return_reason.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the return reasons list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`return_reason.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the return reasons list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -0,0 +1,20 @@
import OrderContent from "./_content/order.mdx"
import ReturnReasonContent from "./_content/return-reason.mdx"
export const metadata = {
title: `Order Module's Admin Widget Injection Zones`,
}
# {metadata.title}
This reference shows all the injection zones in the Medusa Admin related to the Order Module.
## Order Pages
<OrderContent />
---
## Return Reason Pages
<ReturnReasonContent />