Class Injector

Type declaration

• addMenuItem: (<T>(navId, item, sectionId?, indexInSection?) => (() => void))

  • • <T>(navId, item, sectionId?, indexInSection?): (() => void)

    • A utility function to add an item to any context menu. By default, items are placed in a group for custom items, though that can be customized with sectionId and indexInSection

      Type Parameters

      • T extends Record<string, unknown> = Record<string, unknown>

      Parameters

      • navId: ContextMenuTypes

        The id of the menu to add to

      • item: GetContextItem<T>

        The function that creates the item to add

      • sectionId: undefined | number = undefined

        — The number of the section to add to. Defaults to replugged's section

      • indexInSection: number = Infinity

        — The index in the section to add to. Defaults to the end position

      Returns (() => void)

      A callback to de-register the function

      • • (): void

        • Add an item to any context menu

          Returns void

          A callback to de-register the function

      Example

      import { Injector, components, types } from "replugged";
      const { ContextMenu: { MenuItem } } = components;
      const { ContextMenuTypes } = types;
      
      const injector = new Injector();
      
      export function start() {
        injector.utils.addMenuItem(ContextMenuTypes.UserContext,  // Right-clicking a user
          (data, menu) => {
            return <MenuItem
              id="my-item"
              label="An Item!"
              action={() => console.log(data)}
            />
          }
        )
      }
      
      export function stop() {
        injector.uninjectAll();
      }
      Copy

• addPopoverButton: ((item) => (() => void))

  • • (item): (() => void)

    • A utility function to add a button to any message popover.

      Parameters

      • item: GetButtonItem

        The function that creates the button to add

      Returns (() => void)

      Uninject Function.

      • • (): void

        • Adds a button to any MessagePopover

          Returns void

          A callback to remove the button from set.

      Example

      import { Injector, webpack } from "replugged";
      
      const injector = new Injector();
      
      export function start() {
        injector.utils.addPopoverButton((msg: Message, channel: Channel) => {
          return {
            label: "Click the button!",
            icon: myVeryCoolIcon(), // Cool icon
            onClick: () => {
              // do stuff here when someone left clicks the button
            },
            onContextMenu: () => {
              // do other stuff here when someone right clicks the button
            },
          };
        });
      }
      
      export function stop() {
        injector.uninjectAll();
      }
      Copy

• registerSlashCommand: (<const T>(cmd) => (() => void))

  • • <const T>(cmd): (() => void)

    • A utility function to add a custom slash command.

      Type Parameters

      • const T extends CommandOptions

      Parameters

      • cmd: RepluggedCommand<T>

        The slash command to add to register

      Returns (() => void)

      A callback to de-register the command

      • • (): void

        • Code to register an slash command

          Returns void

          An Callback to unregister the slash command

      Example

      import { Injector, components, types } from "replugged";
      
      const injector = new Injector();
      
      export function start() {
        injector.utils.registerSlashCommand({
             name: "use",
             description: "a command meant to be used",
             usage: "/use",
             executor: (interaction) => {},
         })
      }
      
      export function stop() {
        injector.uninjectAll();
      }
      Copy