Files
medusa-store/www/apps/book/app/basics/admin-customizations/page.mdx
2024-09-06 10:33:34 +02:00

54 lines
1.4 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
export const metadata = {
title: `${pageNumber} Admin Customizations`,
}
# {metadata.title}
In this chapter, youll learn how to customize the Medusa Admin dashboard.
## What is the Medusa Admin?
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-sdk"
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 products details page.
### Test the Widget
To test out the widget, start the Medusa application:
```bash npm2yarn
npm run dev
```
Then, open a products details page in the Medusa Admin. Youll find your custom widget at the top of the page.