-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: split admin widget zone to pages
- Loading branch information
1 parent
fd1afa8
commit b880e5d
Showing
57 changed files
with
3,014 additions
and
2,379 deletions.
There are no files selected for viewing
2,457 changes: 80 additions & 2,377 deletions
2,457
www/apps/resources/app/admin-widget-injection-zones/page.mdx
Large diffs are not rendered by default.
Oops, something went wrong.
93 changes: 93 additions & 0 deletions
93
www/apps/resources/app/commerce-modules/api-key/admin-widget-zones/_content.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> | ||
|
|
||
| `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<AdminApiKey>` imported from `@medusajs/framework/types` | ||
|
|
||
| ```ts blockStyle="inline" | ||
| { | ||
| data, // AdminApiKey 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<AdminApiKey>` imported from `@medusajs/framework/types` | ||
|
|
||
| ```ts blockStyle="inline" | ||
| { | ||
| data, // AdminApiKey object | ||
| } | ||
| ``` | ||
|
|
||
| </Table.Cell> | ||
| </Table.Row> | ||
| </Table.Body> | ||
| </Table> |
13 changes: 13 additions & 0 deletions
13
www/apps/resources/app/commerce-modules/api-key/admin-widget-zones/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| import ApiKeyContent from "./_content.mdx" | ||
|
|
||
| export const metadata = { | ||
| title: `API Key Module's Admin Widget Injection Zones`, | ||
| } | ||
|
|
||
| # {metadata.title} | ||
|
|
||
| This reference shows all the injection zones in the Medusa Admin related to the API Key Module. | ||
|
|
||
| ## API Key Pages | ||
|
|
||
| <ApiKeyContent /> |
47 changes: 47 additions & 0 deletions
47
www/apps/resources/app/commerce-modules/auth/admin-widget-zones/_content.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| 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> | ||
|
|
||
| `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> |
13 changes: 13 additions & 0 deletions
13
www/apps/resources/app/commerce-modules/auth/admin-widget-zones/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| import LoginContent from "./_content.mdx" | ||
|
|
||
| export const metadata = { | ||
| title: `Auth Module's Admin Widget Injection Zones`, | ||
| } | ||
|
|
||
| # {metadata.title} | ||
|
|
||
| This reference shows all the injection zones in the Medusa Admin related to the Auth Module. | ||
|
|
||
| ## Login Pages | ||
|
|
||
| <LoginContent /> |
93 changes: 93 additions & 0 deletions
93
...es/app/commerce-modules/customer/admin-widget-zones/_content/customer-group.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> | ||
|
|
||
| `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/framework/types` | ||
|
|
||
| ```ts blockStyle="inline" | ||
| { | ||
| data, // AdminCustomerGroup 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/framework/types` | ||
|
|
||
| ```ts blockStyle="inline" | ||
| { | ||
| data, // AdminCustomerGroup object | ||
| } | ||
| ``` | ||
|
|
||
| </Table.Cell> | ||
| </Table.Row> | ||
| </Table.Body> | ||
| </Table> |
93 changes: 93 additions & 0 deletions
93
...esources/app/commerce-modules/customer/admin-widget-zones/_content/customer.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> | ||
|
|
||
| `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/framework/types` | ||
|
|
||
| ```ts blockStyle="inline" | ||
| { | ||
| data, // AdminCustomer 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/framework/types` | ||
|
|
||
| ```ts blockStyle="inline" | ||
| { | ||
| data, // AdminCustomer object | ||
| } | ||
| ``` | ||
|
|
||
| </Table.Cell> | ||
| </Table.Row> | ||
| </Table.Body> | ||
| </Table> |
20 changes: 20 additions & 0 deletions
20
www/apps/resources/app/commerce-modules/customer/admin-widget-zones/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import CustomerContent from "./_content/customer.mdx" | ||
| import CustomerGroupContent from "./_content/customer-group.mdx" | ||
|
|
||
| export const metadata = { | ||
| title: `Customer Module's Admin Widget Injection Zones`, | ||
| } | ||
|
|
||
| # {metadata.title} | ||
|
|
||
| This reference shows all the injection zones in the Medusa Admin related to the Customer Module. | ||
|
|
||
| ## Customer Pages | ||
|
|
||
| <CustomerContent /> | ||
|
|
||
| --- | ||
|
|
||
| ## Customer Group Pages | ||
|
|
||
| <CustomerGroupContent /> |
Oops, something went wrong.