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

This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-12-24 12:29:41 +02:00
1 parent fd1afa8bc9
commit 041baafd38
57 files changed
+2992 -2357

No files matched your search

@@ -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>
`campaign.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the campaigns list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the campaigns list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a campaign's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminCampaign>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminCampaign object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a campaign's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminCampaign>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminCampaign object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the campaign details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminCampaign>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminCampaign object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the second column in the campaign details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminCampaign>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminCampaign object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -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>
`promotion.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the promotions list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the promotions list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a promotion's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminPromotion>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminPromotion object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a promotion's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminPromotion>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminPromotion object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the promotion details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminPromotion>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminPromotion object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the second column in the promotion details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminPromotion>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminPromotion object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -0,0 +1,20 @@
import CampaignContent from "./_content/campaign.mdx"
import PromotionContent from "./_content/promotion.mdx"
export const metadata = {
title: `Promotion Module's Admin Widget Injection Zones`,
}
# {metadata.title}
This reference shows all the injection zones in the Medusa Admin related to the Promotion Module.
## Campaign Pages
<CampaignContent />
---
## Promotion Pages
<PromotionContent />