Medusa Plugin Settings

Documentation

Contact

Usage

Installation

1
npm i medusa-plugin-settings

Run Migrations

1
npm run build

1
npx medusa migrations run

Configuration

123456789101112131415161718192021222324252627
// medusa-config.js

const plugins = [
  /** @type {import('medusa-plugin-settings').PluginOptions} */
  {
    resolve: "medusa-plugin-settings",
    options: {
      enableUI: true,
      backendUrl: process.env.BACKEND_URL || "http://localhost:9000",
      settings: [
        {
          id: "is-store-working",
          name: "Is Store Enabled",
          type: SettingSchemaTypes.BOOLEAN,
          defaultValue: true,
          // optional
          description:
            "If set to false store-front will no more be accessible.",
          note: "BE CARFUL!",
        },
        // other settings..
      ],
    },
  },
];

// ...

Use Settings

Endpoints

• Copy to clipboardGET Copy to clipboard<BACKEND_URL>/store/extended-settings
• Copy to clipboardGET Copy to clipboard<BACKEND_URL>/store/extended-settings/:settingId

Documentation

Examples & Use Cases

• Use Case -1
• Use Case -2
• Use Case -3
• Use Case -4

Contribution

Features

• Effortless UI Integration for Settings: The Medusa Plugin Settings simplifies the incorporation of new settings into your admin dashboard. Mark your settings with a decorator, and watch as the plugin seamlessly creates a user interface within the Medusa dashboard.
• Streamlined Configuration Operations: With the added UI, managing your settings becomes a breeze. Perform essential configuration tasks such as creating new settings, editing existing ones, viewing detailed information, and deleting settings with unparalleled ease.
• Tailor to Your Needs: Customize the generated UI according to your specific requirements. The Medusa Plugin Settings provides flexibility in controlling the appearance and behavior of UI elements, ensuring a personalized experience.
• Endpoint Exposure for Enhanced Interaction: Beyond dashboard integration, this plugin exposes your settings through a dedicated endpoint. This feature facilitates seamless interaction between your store and the configured settings, offering a programmatic avenue for efficient communication.