964927b597
* docs improvements and changes * updated module definition * modules + dml changes * fix build * fix vale error * fix lint errors * fixes to stripe docs * fix condition * fix condition * fix module defintion * fix checkout * disable UI action * change oas preview action * flatten provider module options * fix lint errors * add module link docs * pr comments fixes * fix vale error * change node engine version * links -> linkable * add note about database name * small fixes * link fixes * fix response code in api reference * added migrations step
54 lines
1.4 KiB
Plaintext
54 lines
1.4 KiB
Plaintext
export const metadata = {
|
||
title: `${pageNumber} Admin Customizations`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
In this chapter, you’ll learn how to customize the Medusa Admin dashboard.
|
||
|
||
## 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. In your customizations, you interact with API routes to provide merchants with custom functionalities.
|
||
|
||
The Medusa Admin is installed in your Medusa application and runs at `http://localhost:9000/app` when you start the application.
|
||
|
||
---
|
||
|
||
## Example: Create a Widget
|
||
|
||
A widget is a React component that can be injected into an existing page in the admin dashboard.
|
||
|
||
For example, create the file `src/admin/widgets/product-widget.tsx` with the following content:
|
||
|
||
```tsx title="src/admin/widgets/product-widget.tsx"
|
||
import { defineWidgetConfig } from "@medusajs/admin-shared"
|
||
|
||
const ProductWidget = () => {
|
||
return (
|
||
<div>
|
||
<h2>Product Widget</h2>
|
||
</div>
|
||
)
|
||
}
|
||
|
||
export const config = defineWidgetConfig({
|
||
zone: "product.details.before",
|
||
})
|
||
|
||
export default ProductWidget
|
||
```
|
||
|
||
This inserts a widget with the text “Product Widget” at the beginning of a product’s details page.
|
||
|
||
### Test the Widget
|
||
|
||
To test out the widget, start the Medusa application:
|
||
|
||
```bash npm2yarn
|
||
npm run dev
|
||
```
|
||
|
||
Then, open a product’s details page in the Medusa Admin. You’ll find your custom widget at the top of the page.
|