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
This commit is contained in:
Shahed Nasser
2024-05-29 13:50:19 +03:00
committed by GitHub
parent 72b57e2ae4
commit 130de74d6d
15 changed files with 1647 additions and 2917 deletions
@@ -6,19 +6,13 @@ export const metadata = {
In this chapter, youll learn how to customize the Medusa Admin dashboard.
<Note type="soon">
Admin customizations are coming soon.
</Note>
## Overview
The Medusa Admin is an admin dashboard that merchants use to manage their store's data.
You can extend the Medusa Admin to add widgets and new pages. Your customizations interact with API routes to provide merchants with custom functionalities.
The Medusa Admin is installed in your Medusa application and runs at port `7001` when you start the Medusa application.
The Medusa Admin is installed in your Medusa application and runs at the path `/app` when you start the Medusa application.
---
@@ -29,7 +23,7 @@ A widget is a React component that can be injected into an existing page in the
For example, create the file `src/admin/widgets/product-widget.tsx` with the following content:
```tsx title="src/admin/widgets/product-widget.tsx"
import type { WidgetConfig } from "@medusajs/admin"
import { defineWidgetConfig } from "@medusajs/admin-shared"
const ProductWidget = () => {
return (
@@ -39,9 +33,9 @@ const ProductWidget = () => {
)
}
export const config: WidgetConfig = {
export const config = defineWidgetConfig({
zone: "product.details.after",
}
})
export default ProductWidget
```