asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
00a6e512dca3bfd4b520b86c07ef639ccfc4a6c8
medusa-store/www/apps/resources/app/admin-widget-injection-zones/page.mdx
Shahed Nasser 130de74d6d docs: updates to admin customization docs (#7493) 
* updated admin docs

* re-add navigation and parameters sections

* update injection zones

* update cli scripts docs

* added list of injection zones

* add details about widget props

* restructure admin injection zones
2024-05-29 13:50:19 +03:00

2196 lines
40 KiB
Plaintext
Raw Blame History

import { Table } from "docs-ui"
export const metadata = {
title: `Admin Widget Injection Zones`,
}
# {metadata.title}
This documentation page includes the list of injection zones you can add Admin Widgets to.
## Login Page
<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>
`login.before`
</Table.Cell>
<Table.Cell>
Added before the login form.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`login.after`
</Table.Cell>
<Table.Cell>
Added after the login form.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
---
## Order Pages
<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/types`
```ts noCopy noReport
{
data, // Order 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/types`
```ts noCopy noReport
{
data, // Order 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/types`
```ts noCopy noReport
{
data, // Order object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.details.side.before`
</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/types`
```ts noCopy noReport
{
data, // Order object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
---
## Customer Pages
<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>
`customer.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the customers list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the customers list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of the customer details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminCustomer>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Customer object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the customer details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminCustomer>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Customer object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer_group.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the customer groups list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer_group.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the customer groups list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer_group.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of the customer group details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminCustomerGroup>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // CustomerGroup object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer_group.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the customer group details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminCustomerGroup>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // CustomerGroup object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
---
## Product Pages
<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>
`product.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the product list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the products list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of the product details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProduct>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Product object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the product details page
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProduct>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Product object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the product details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProduct>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Product object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the second column in the product details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProduct>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Product object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_collection.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the product collections list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_collection.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the product collections list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_collection.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of the product collection details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductCollection>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ProductCollection object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_collection.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the product collection details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductCollection>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ProductCollection object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_category.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the product categories list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_category.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the product categories list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_category.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of the product category details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductCategory>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ProductCategory object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_category.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the product category details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductCategory>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ProductCategory object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_category.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the product category details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductCategory>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ProductCategory object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_category.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the second column in the product category details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductCategory>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ProductCategory object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
---
## Pricing Pages
<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>
`price_list.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the Pricing list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price_list.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the Pricing list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price_list.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a price list's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<PriceListDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // PriceList object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price_list.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a price list's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<PriceListDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // PriceList object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price_list.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the price list details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<PriceListDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // PriceList object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price_list.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the second column in the price list details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<PriceListDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // PriceList object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
---
## Promotion Pages
<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<PromotionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Promotion 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<PromotionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Promotion 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<PromotionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Promotion 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<PromotionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Promotion object
}
```
</Table.Cell>
</Table.Row>
<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<CampaignDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Campaign 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<CampaignDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Campaign 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<CampaignDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Campaign 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<CampaignDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Campaign object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
---
## Setting Pages
### User Pages
<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>
`user.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the users list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`user.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the users list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`user.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a user's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<UserDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // User object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`user.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a user's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<UserDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // User object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Store Pages
<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>
`store.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a store's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ExtendedStoreDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Store object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`store.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a store's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ExtendedStoreDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Store object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Profile Pages
<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>
`profile.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a profile's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<UserDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // User object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`profile.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a profile's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<UserDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // User object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Region Pages
<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>
`region.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the regions list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`region.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the regions list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`region.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a region's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminRegion>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Region object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`region.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a region's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminRegion>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // Region object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Shipping Profile Pages
<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_profile.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the shipping profiles list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping_profile.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the shipping profiles list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping_profile.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a shipping profile's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ShippingProfileDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ShippingProfile object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping_profile.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a shipping profile's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ShippingProfileDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ShippingProfile object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Location Pages
<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>
`location.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the locations list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`location.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the locations list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`location.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a location's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ExtendedStockLocationDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // StockLocation object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`location.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a location's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ExtendedStockLocationDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // StockLocation object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`location.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the location details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ExtendedStockLocationDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // StockLocation object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`location.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the second column in the location details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ExtendedStockLocationDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // StockLocation object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Sales Channel Pages
<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>
`sales_channel.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the sales channels list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`sales_channel.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the sales channels list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`sales_channel.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a sales channel's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<SalesChannelResponse>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // SalesChannel object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`sales_channel.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a sales channel's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<SalesChannelResponse>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // SalesChannel object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Reservation Pages
<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<ReservationItemDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ReservationItem 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<ReservationItemDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ReservationItem 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<ReservationItemDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ReservationItem 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<ReservationItemDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ReservationItem object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### API Key Pages
<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>
`api_key.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the API keys list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`api_key.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the API keys list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`api_key.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a API key's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ApiKeyResponse>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ApiKey object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`api_key.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a API key's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<ApiKeyResponse>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // ApiKey object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Workflow Pages
<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>
`workflow.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the workflows list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`workflow.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the workflows list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`workflow.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a workflow execution's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<WorkflowExecutionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // WorkflowExecution object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`workflow.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a workflow execution's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<WorkflowExecutionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // WorkflowExecution object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Tax Pages
<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>
`tax.list.before`
</Table.Cell>
<Table.Cell>
Added at the top of the tax regions list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`tax.list.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the tax regions list page.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`tax.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of a tax region's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<TaxRegionResponse>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // TaxRegion object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`tax.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of a tax region's details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<TaxRegionResponse>` imported from `@medusajs/types`
```ts noCopy noReport
{
data, // TaxRegion object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
Reference in New Issue View Git Blame Copy Permalink