asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/commerce-modules/inventory/admin-widget-zones/_content/inventory.mdx
+139
View File
@@ -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>
`inventory_item.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the inventory list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory_item.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the inventory list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory_item.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of the inventory item details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminInventoryItem>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminInventoryItem object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory_item.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the inventory item details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminInventoryItem>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminInventoryItem object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory_item.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the inventory item details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminInventoryItem>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminInventoryItem object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory_item.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the end of the second column in the inventory item details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminInventoryItem>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminInventoryItem object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/inventory/admin-widget-zones/_content/reservation.mdx
+139
View File
@@ -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>
`reservation.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the reservations list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`reservation.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the reservations list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`reservation.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a reservation item's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminReservation>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminReservation object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`reservation.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a reservation item's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminReservation>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminReservation object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`reservation.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the reservation item details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminReservation>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminReservation object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`reservation.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the second column in the reservation item details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminReservation>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminReservation object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/inventory/admin-widget-zones/page.mdx
+20
View File
@@ -0,0 +1,20 @@
import InventoryContent from "./_content/inventory.mdx"
import ReservationContent from "./_content/reservation.mdx"
export const metadata = {
title: `Inventory Module's Admin Widget Injection Zones`,
}
# {metadata.title}
This reference shows all the injection zones in the Medusa Admin related to the Inventory Module.
## Inventory Pages
<InventoryContent />
---
## Reservation Pages
<ReservationContent />