README.md

Mobile User Menu Slot

Slot ID: mobile_user_menu_slot

Description

This slot is used to replace/modify/hide the mobile user menu.

Examples

Modify Items

The following env.config.jsx will modify the items in the mobile user menu.

import { PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';

const modifyUserMenu = ( widget ) => {
  widget.content.menu = [
    {
      items: [
        {
          type: 'item',
          href: 'https://openedx.org/',
          content: 'openedx.org',
        },
        {
          type: 'item',
          href: 'https://docs.openedx.org/en/latest/',
          content: 'Documentation',
        },
      ]
    },
    {
      items: [
        {
          type: 'item',
          href: 'https://discuss.openedx.org/',
          content: 'Forums',
        }
      ]
    }
  ];
  return widget;
};

const config = {
  pluginSlots: {
    mobile_user_menu_slot: {
      keepDefault: true,
      plugins: [
        {
          op: PLUGIN_OPERATIONS.Modify,
          widgetId: 'default_contents',
          fn: modifyUserMenu,
        },
      ]
    },
  },
}

export default config;

Replace Menu with Custom Component

The following env.config.jsx will replace the mobile main user entirely (in this case with a centered 🗺️ h1)

import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';

const config = {
  pluginSlots: {
    mobile_user_menu_slot: {
      keepDefault: false,
      plugins: [
        {
          op: PLUGIN_OPERATIONS.Insert,
          widget: {
            id: 'custom_user_menu_component',
            type: DIRECT_PLUGIN,
            RenderWidget: () => (
              <h1 style={{textAlign: 'center'}}>🗺️</h1>
            ),
          },
        },
      ]
    },
  },
}

export default config;

Add Custom Components before and after Menu

The following env.config.jsx will place custom components before and after the mobile user menu (in this case centered h1s with 🌞 and 🌚).

import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';

const config = {
  pluginSlots: {
    mobile_user_menu_slot: {
      keepDefault: true,
      plugins: [
        {
          op: PLUGIN_OPERATIONS.Insert,
          widget: {
            id: 'custom_before_user_menu_component',
            type: DIRECT_PLUGIN,
            priority: 10,
            RenderWidget: () => (
              <h1 style={{textAlign: 'center'}}>🌞</h1>
            ),
          },
        },
        {
          op: PLUGIN_OPERATIONS.Insert,
          widget: {
            id: 'custom_after_user_menu_component',
            type: DIRECT_PLUGIN,
            priority: 90,
            RenderWidget: () => (
              <h1 style={{textAlign: 'center'}}>🌚</h1>
            ),
          },
        },
      ]
    },
  },
}

export default config;