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

docs: redesign tables (#8653)

Browse Source 
* docs: redesign tables

* fixes
This commit is contained in:
Shahed Nasser
2024-08-20 15:47:36 +03:00
committed by GitHub
parent 73905c14b1
commit b8ba020cd5
33 changed files with 226 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
www/apps/resources/app/admin-widget-injection-zones/page.mdx
View File

@@ -56,8 +56,6 @@ This documentation page includes the list of injection zones you can add Admin W
</Table.Body>
</Table>
---
## Order Pages
<Table>
@@ -118,7 +116,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Order object
}
@@ -141,7 +139,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Order object
}
@@ -164,7 +162,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Order object
}
@@ -187,7 +185,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Order object
}
@@ -198,8 +196,6 @@ This documentation page includes the list of injection zones you can add Admin W
</Table.Body>
</Table>
---
## Customer Pages
<Table>
@@ -260,7 +256,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminCustomer>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Customer object
}
@@ -283,7 +279,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminCustomer>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Customer object
}
@@ -340,7 +336,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminCustomerGroup>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // CustomerGroup object
}
@@ -363,7 +359,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminCustomerGroup>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // CustomerGroup object
}
@@ -374,8 +370,6 @@ This documentation page includes the list of injection zones you can add Admin W
</Table.Body>
</Table>
---
## Product Pages
<Table>
@@ -436,7 +430,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProduct>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Product object
}
@@ -459,7 +453,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProduct>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Product object
}
@@ -482,7 +476,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProduct>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Product object
}
@@ -505,7 +499,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProduct>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Product object
}
@@ -562,7 +556,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProductCollection>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ProductCollection object
}
@@ -585,7 +579,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProductCollection>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ProductCollection object
}
@@ -642,7 +636,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProductCategory>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ProductCategory object
}
@@ -665,7 +659,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProductCategory>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ProductCategory object
}
@@ -688,7 +682,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProductCategory>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ProductCategory object
}
@@ -711,7 +705,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminProductCategory>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ProductCategory object
}
@@ -722,8 +716,6 @@ This documentation page includes the list of injection zones you can add Admin W
</Table.Body>
</Table>
---
## Pricing Pages
<Table>
@@ -784,7 +776,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<PriceListDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // PriceList object
}
@@ -807,7 +799,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<PriceListDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // PriceList object
}
@@ -830,7 +822,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<PriceListDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // PriceList object
}
@@ -853,7 +845,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<PriceListDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // PriceList object
}
@@ -864,8 +856,6 @@ This documentation page includes the list of injection zones you can add Admin W
</Table.Body>
</Table>
---
## Promotion Pages
<Table>
@@ -926,7 +916,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<PromotionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Promotion object
}
@@ -949,7 +939,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<PromotionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Promotion object
}
@@ -972,7 +962,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<PromotionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Promotion object
}
@@ -995,7 +985,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<PromotionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Promotion object
}
@@ -1052,7 +1042,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<CampaignDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Campaign object
}
@@ -1075,7 +1065,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<CampaignDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Campaign object
}
@@ -1098,7 +1088,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<CampaignDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Campaign object
}
@@ -1121,7 +1111,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<CampaignDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Campaign object
}
@@ -1132,8 +1122,6 @@ This documentation page includes the list of injection zones you can add Admin W
</Table.Body>
</Table>
---
## Setting Pages
### User Pages
@@ -1196,7 +1184,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<UserDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // User object
}
@@ -1219,7 +1207,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<UserDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // User object
}
@@ -1256,7 +1244,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ExtendedStoreDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Store object
}
@@ -1279,7 +1267,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ExtendedStoreDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Store object
}
@@ -1316,7 +1304,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<UserDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // User object
}
@@ -1339,7 +1327,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<UserDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // User object
}
@@ -1410,7 +1398,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminRegion>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Region object
}
@@ -1433,7 +1421,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<AdminRegion>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // Region object
}
@@ -1504,7 +1492,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ShippingProfileDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ShippingProfile object
}
@@ -1527,7 +1515,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ShippingProfileDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ShippingProfile object
}
@@ -1598,7 +1586,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ExtendedStockLocationDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // StockLocation object
}
@@ -1621,7 +1609,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ExtendedStockLocationDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // StockLocation object
}
@@ -1644,7 +1632,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ExtendedStockLocationDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // StockLocation object
}
@@ -1667,7 +1655,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ExtendedStockLocationDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // StockLocation object
}
@@ -1738,7 +1726,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<SalesChannelResponse>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // SalesChannel object
}
@@ -1761,7 +1749,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<SalesChannelResponse>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // SalesChannel object
}
@@ -1832,7 +1820,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ReservationItemDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ReservationItem object
}
@@ -1855,7 +1843,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ReservationItemDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ReservationItem object
}
@@ -1878,7 +1866,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ReservationItemDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ReservationItem object
}
@@ -1901,7 +1889,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ReservationItemDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ReservationItem object
}
@@ -1972,7 +1960,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ApiKeyResponse>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ApiKey object
}
@@ -1995,7 +1983,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<ApiKeyResponse>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // ApiKey object
}
@@ -2066,7 +2054,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<WorkflowExecutionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // WorkflowExecution object
}
@@ -2089,7 +2077,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<WorkflowExecutionDTO>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // WorkflowExecution object
}
@@ -2160,7 +2148,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<TaxRegionResponse>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // TaxRegion object
}
@@ -2183,7 +2171,7 @@ This documentation page includes the list of injection zones you can add Admin W
Type `DetailWidgetProps<TaxRegionResponse>` imported from `@medusajs/types`
```ts noCopy noReport
```ts blockStyle="inline"
{
data, // TaxRegion object
}

2
www/apps/resources/app/architectural-modules/cache/redis/page.mdx vendored
View File

@@ -159,8 +159,6 @@ CACHE_REDIS_URL=<YOUR_REDIS_URL>
</Table.Body>
</Table>
---
## Test the Module
To test the module, start the Medusa application:

2
www/apps/resources/app/architectural-modules/event/redis/page.mdx
View File

@@ -207,8 +207,6 @@ EVENTS_REDIS_URL=<YOUR_REDIS_URL>
</Table.Body>
</Table>
---
## Test the Module
To test the module, start the Medusa application:

2
www/apps/resources/app/architectural-modules/file/s3/page.mdx
View File

@@ -333,8 +333,6 @@ module.exports = {
</Table.Body>
</Table>
---
## Troubleshooting
<DetailsList

2
www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx
View File

@@ -100,8 +100,6 @@ SENDGRID_FROM=<YOUR_SENDGRID_FROM>
</Table.Body>
</Table>
---
## SendGrid Templates
When you send a notification, you must specify the ID of the template to use in SendGrid.

2
www/apps/resources/app/architectural-modules/workflow-engine/redis/page.mdx
View File

@@ -164,8 +164,6 @@ WE_REDIS_URL=<YOUR_REDIS_URL>
</Table.Body>
</Table>
---
## Test the Module
To test the module, start the Medusa application:

2
www/apps/resources/app/commerce-modules/api-key/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted API key
id,

2
www/apps/resources/app/commerce-modules/auth/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted auth identity
id,

2
www/apps/resources/app/commerce-modules/auth/auth-providers/emailpass/page.mdx
View File

@@ -76,7 +76,7 @@ const modules = {
</Table.Cell>
<Table.Cell>
```ts noCopy noReport noLineNumbers
```ts blockStyle="inline"
const hashConfig = {
logN: 15,
r: 8,

16
www/apps/resources/app/commerce-modules/cart/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted cart
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted address
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item adjustment
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item tax line
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method adjustment
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method tax line
id,

2
www/apps/resources/app/commerce-modules/currency/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted currency
id,

8
www/apps/resources/app/commerce-modules/customer/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted customer
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted address
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted customer group
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted customer group customer
id,

22
www/apps/resources/app/commerce-modules/fulfillment/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the fulfillment set
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted fulfillment set
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the service zone
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted service zone
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the geo zone
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted geo zone
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the shipping option
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the shipping profile
id,
@@ -198,7 +198,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the shipping option rule
id,
@@ -220,7 +220,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the shipping option type
id,
@@ -242,7 +242,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the fulfillment provider
id,

18
www/apps/resources/app/commerce-modules/inventory/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the inventory item
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the inventory item
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted inventory item
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the inventory level
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the inventory level
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted inventory level
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the reservation item
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the reservation item
id,
@@ -198,7 +198,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted reservation item
id,

28
www/apps/resources/app/commerce-modules/order/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted address
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item adjustment
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted line item tax line
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method adjustment
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted shipping method tax line
id,
@@ -198,7 +198,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted transaction
id,
@@ -220,7 +220,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order change
id,
@@ -242,7 +242,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order change action
id,
@@ -264,7 +264,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order item
id,
@@ -286,7 +286,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order summary
id,
@@ -308,7 +308,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted order shipping method
id,

2
www/apps/resources/app/commerce-modules/order/transactions/page.mdx
View File

@@ -79,8 +79,6 @@ To check the outstanding amount of the order, its transaction amounts are summed
</Table.Body>
</Table>
---
## Transaction Reference
The Order Module doesn’t provide payment processing functionalities, so it doesn’t store payments that can be processed. Payment functionalities are provided by the [Payment Module](../../payment/page.mdx).

10
www/apps/resources/app/commerce-modules/payment/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted payment
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted payment collection
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted payment session
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted capture
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted refund
id,

2
www/apps/resources/app/commerce-modules/payment/module-options/page.mdx
View File

@@ -93,8 +93,6 @@ In this document, you'll learn about the options of the Payment Module.
</Table.Body>
</Table>
---
## providers
The `providers` option is an array of payment module providers.

2
www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx
View File

@@ -197,8 +197,6 @@ STRIPE_API_KEY=<YOUR_STRIPE_API_KEY>
</Table.Body>
</Table>
---
## Use Provider
To use the Stripe provider, create a payment session for the provider:

16
www/apps/resources/app/commerce-modules/pricing/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price set
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price list
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price list rule
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price list rule value
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price rule
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted price set rule type
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted rule type
id,

26
www/apps/resources/app/commerce-modules/product/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product collection
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product collection
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product collection
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product category
id,
@@ -176,7 +176,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the product category
id,
@@ -198,7 +198,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product category
id,
@@ -220,7 +220,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product option
id,
@@ -242,7 +242,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product tag
id,
@@ -264,7 +264,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product type
id,
@@ -286,7 +286,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted product variant
id,

12
www/apps/resources/app/commerce-modules/promotion/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted promotion
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted application method
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted campaign
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted campaign budget
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted promotion rule
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted promotion rule value
id,

4
www/apps/resources/app/commerce-modules/region/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted region
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted country
id,

2
www/apps/resources/app/commerce-modules/sales-channel/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted sales channel
id,

4
www/apps/resources/app/commerce-modules/stock-location/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted stock location
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted stock location address
id,

2
www/apps/resources/app/commerce-modules/store/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted store
id,

8
www/apps/resources/app/commerce-modules/tax/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted tax rate
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted tax region
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted tax rate rule
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted tax provider
id,

14
www/apps/resources/app/commerce-modules/user/_events/_events-table/page.mdx
View File

@@ -22,7 +22,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the user
id,
@@ -44,7 +44,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the user
id,
@@ -66,7 +66,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted user
id,
@@ -88,7 +88,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the invite
id,
@@ -110,7 +110,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the invite
id,
@@ -132,7 +132,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the deleted invite
id,
@@ -154,7 +154,7 @@ import { Table } from "docs-ui"
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
```ts blockStyle="inline"
{
// the ID of the invite
id,

6
www/apps/ui/src/components/hook-table.tsx
View File

@@ -1,13 +1,13 @@
import { InformationCircleSolid } from "@medusajs/icons"
import { Table, Tooltip } from "@medusajs/ui"
import { Tooltip } from "@medusajs/ui"
import { HookData, HookDataMap } from "@/types/hooks"
import { EnumType, FunctionType, ObjectType } from "@/types/props"
import { InlineCode } from "docs-ui"
import { InlineCode, Table } from "docs-ui"
const HookTable = ({ props }: { props: HookDataMap }) => {
return (
<Table>
<Table className="!mb-0">
<Table.Header className="border-t-0">
<Table.Row>
<Table.HeaderCell>Value</Table.HeaderCell>

8
www/apps/ui/src/components/props-table.tsx
View File

@@ -1,11 +1,11 @@
"use client"
import { InformationCircleSolid } from "@medusajs/icons"
import { Table, Tooltip } from "@medusajs/ui"
import { Tooltip } from "@medusajs/ui"
import { PropData, PropDataMap, PropSpecType } from "@/types/props"
import { useCallback, useMemo } from "react"
import { InlineCode, MarkdownContent } from "docs-ui"
import { InlineCode, MarkdownContent, Table } from "docs-ui"
type PropTableProps = {
props: PropDataMap
@@ -13,12 +13,12 @@ type PropTableProps = {
const PropTable = ({ props }: PropTableProps) => {
return (
<Table>
<Table className="!mb-0">
<Table.Header className="border-t-0">
<Table.Row>
<Table.HeaderCell>Prop</Table.HeaderCell>
<Table.HeaderCell>Type</Table.HeaderCell>
<Table.HeaderCell className="text-right">Default</Table.HeaderCell>
<Table.HeaderCell className="!text-right">Default</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body className="border-b-0 [&_tr:last-child]:border-b-0">

20
www/packages/docs-ui/src/components/CodeBlock/Inline/index.tsx Normal file
View File

@@ -0,0 +1,20 @@
import React from "react"
import clsx from "clsx"
import { CodeBlockProps } from "../../.."
export const CodeBlockInline = ({ source }: CodeBlockProps) => {
return (
<pre
className={clsx(
"px-[6px] bg-medusa-tag-neutral-bg",
"w-full my-docs_0.5 rounded-docs_sm",
"border border-medusa-tag-neutral-border",
"whitespace-pre-wrap"
)}
>
<code className="w-full text-code-label text-medusa-tag-neutral-text">
{source}
</code>
</pre>
)
}

6
www/packages/docs-ui/src/components/CodeBlock/index.tsx
View File

@@ -14,6 +14,7 @@ import { HighlightProps as CollapsibleHighlightProps } from "@/hooks"
import { CodeBlockActions, CodeBlockActionsProps } from "./Actions"
import { CodeBlockCollapsibleButton } from "./Collapsible/Button"
import { CodeBlockCollapsibleFade } from "./Collapsible/Fade"
import { CodeBlockInline } from "./Inline"
export type Highlight = {
line: number
@@ -41,7 +42,7 @@ export type CodeBlockMetaFields = {
isTerminal?: boolean
} & CodeBlockHeaderMeta
export type CodeBlockStyle = "loud" | "subtle"
export type CodeBlockStyle = "loud" | "subtle" | "inline"
export type CodeBlockProps = {
source: string
@@ -75,6 +76,9 @@ export const CodeBlock = ({
if (!source && typeof children === "string") {
source = children
}
if (blockStyle === "inline") {
return <CodeBlockInline source={source} />
}
const { colorMode } = useColorMode()
const [showTesting, setShowTesting] = useState(false)

56
www/packages/docs-ui/src/components/Table/index.tsx
View File

@@ -11,7 +11,24 @@ const Root = ({ className, ...props }: RootProps) => {
className,
"table-fixed mb-docs_1",
"[&_pre_span]:!max-w-full [&_pre_span]:!break-words [&_pre_span]:!whitespace-break-spaces",
"[&_pre>div]:mt-docs_1"
"[&_pre>div]:mt-docs_1",
"shadow-elevation-card-rest dark:shadow-elevation-card-rest-dark",
"rounded-docs_DEFAULT"
)}
{...props}
/>
)
}
type HeaderProps = React.HTMLAttributes<HTMLTableSectionElement>
const Header = ({ className, ...props }: HeaderProps) => {
return (
<UiTable.Header
className={clsx(
className,
"!border-0 bg-medusa-bg-component [&_tr]:!bg-medusa-bg-component",
"rounded-docs_DEFAULT [&_tr]:rounded-docs_DEFAULT"
)}
{...props}
/>
@@ -23,20 +40,11 @@ type HeaderCellProps = React.HTMLAttributes<HTMLTableCellElement>
const HeaderCell = ({ className, ...props }: HeaderCellProps) => {
return (
<UiTable.HeaderCell
className={clsx(className, "text-left pr-docs_1.5 h-docs_3 break-words")}
{...props}
/>
)
}
type RowProps = React.HTMLAttributes<HTMLTableRowElement>
const Row = ({ className, ...props }: RowProps) => {
return (
<UiTable.Row
className={clsx(
className,
"[&_td:last-child]:pr-docs_1.5 [&_th:last-child]:pr-docs_1.5 [&_td:first-child]:pl-docs_1.5 [&_th:first-child]:pl-docs_1.5"
"text-left px-docs_0.75 py-docs_0.5 break-words",
"!text-compact-small-plus text-medusa-fg-subtle",
"first:rounded-tl-docs_DEFAULT last:rounded-tr-docs_DEFAULT"
)}
{...props}
/>
@@ -48,18 +56,32 @@ type CellProps = React.HTMLAttributes<HTMLTableCellElement>
const Cell = ({ className, ...props }: CellProps) => {
return (
<UiTable.Cell
className={clsx(className, "pr-docs_1.5 h-docs_3 break-words")}
className={clsx(
className,
"px-docs_0.75 py-docs_0.5 break-words align-top"
)}
{...props}
/>
)
}
type BodyProps = React.HTMLAttributes<HTMLTableSectionElement>
const Body = ({ className, ...props }: BodyProps) => {
return (
<UiTable.Body
className={clsx(className, "[&_tr:last-child]:border-b-0 border-b-0")}
{...props}
/>
)
}
const Table = Object.assign(Root, {
Row,
Row: UiTable.Row,
Cell,
Header: UiTable.Header,
Header,
HeaderCell,
Body: UiTable.Body,
Body,
})
export { Table }