npm.io
2.22.7 • Published 4d ago

@medusajs/admin-sdk

Licence
—
Version
2.22.7
Deps
2
Size
18 kB
Vulns
0
Weekly
0
Stars
36.8K

Medusa logo

@medusajs/admin-sdk

Documentation | Website

Building blocks for digital commerce

Medusa is released under the MIT license. PRs welcome! Discord Chat Follow @medusajs

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 stable id.
  • defineRouteConfig: set a UI route's sidebar label, icon, nested position, rank, translationNs, and the RBAC permissions required to open it.
  • defineLayoutConfig: declare a custom layout's id and sections.
  • 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

Resources