@medusajs/admin-sdk
Documentation | Website
Building blocks for digital commerce
Admin SDK for Medusa: helpers for configuring Medusa Admin dashboard extensions such as widgets, UI routes, and layouts. Import it in the src/admin directory of a Medusa application or plugin to export the config of each widget or UI route.
At a glance
| Package | @medusajs/admin-sdk |
| Type | Admin |
| Import from | @medusajs/admin-sdk |
Features
defineWidgetConfig: set the injection zone(s) a widget is shown in, with an optional stableid.defineRouteConfig: set a UI route's sidebarlabel,icon,nestedposition,rank,translationNs, and the RBACpermissionsrequired to open it.defineLayoutConfig: declare a custom layout'sidandsections.- Types:
WidgetConfig,RouteConfig,LayoutConfig.
Installation
npm install @medusajs/admin-sdk
Usage
import { defineWidgetConfig } from "@medusajs/admin-sdk"
import { Container, Heading } from "@medusajs/ui"
const ProductWidget = () => {
return (
<Container className="divide-y p-0">
<div className="flex items-center justify-between px-6 py-4">
<Heading level="h2">Product Widget</Heading>
</div>
</Container>
)
}
export const config = defineWidgetConfig({
zone: "product.details",
})
export default ProductWidget