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/product/admin-widget-zones/_content/product-category.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>
`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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductCategory 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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductCategory 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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductCategory 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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductCategory object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/product/admin-widget-zones/_content/product-collection.mdx
+93
View File
@@ -0,0 +1,93 @@
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>
`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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductCollection 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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductCollection object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/product/admin-widget-zones/_content/product-variant.mdx
+111
View File
@@ -0,0 +1,111 @@
import { Table } from "docs-ui"
<Note>
This injection zone is only available after [Medusa v2.0.5](https://github.com/medusajs/medusa/releases/tag/v2.0.5).
</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>
`product_variant.details.before`
</Table.Cell>
<Table.Cell>
Added at the top of the product variant details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductVariant>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductVariant object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_variant.details.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the product variant details page
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductVariant>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductVariant object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_variant.details.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the product variant details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductVariant>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductVariant object
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product_variant.details.side.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the second column in the product variant details page.
</Table.Cell>
<Table.Cell>
Type `DetailWidgetProps<AdminProductVariant>` imported from `@medusajs/framework/types`
```ts blockStyle="inline"
{
data, // AdminProductVariant object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/product/admin-widget-zones/_content/product.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>
`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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProduct 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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProduct 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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProduct 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/framework/types`
```ts blockStyle="inline"
{
data, // AdminProduct object
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/product/admin-widget-zones/page.mdx
+34
View File
@@ -0,0 +1,34 @@
import ProductContent from "./_content/product.mdx"
import ProductVariantContent from "./_content/product-variant.mdx"
import ProductCollectionContent from "./_content/product-collection.mdx"
import ProductCategoryContent from "./_content/product-category.mdx"
export const metadata = {
title: `Product Module's Admin Widget Injection Zones`,
}
# {metadata.title}
This reference shows all the injection zones in the Medusa Admin related to the Product Module.
## Product Pages
<ProductContent />
---
## Product Variant Pages
<ProductVariantContent />
---
## Product Collection Pages
<ProductCollectionContent />
---
## Product Catgory Pages
<ProductCategoryContent />