gridstack_remove_widget

Remove widgets from dynamic dashboards by specifying a selector or ID. Optionally delete from DOM and trigger removal events for responsive grid layouts.

Instructions

Remove a widget from the grid

Input Schema

TableJSON Schema

Name	Required	Description
`el`	Yes	Widget selector or ID to remove
`removeDOM`	No	Remove from DOM as well
`triggerEvent`	No	Trigger 'removed' event

Implementation Reference

src/tools/index.ts:893-904 (handler)

The core handler function that implements the logic for the 'gridstack_remove_widget' tool. It extracts parameters and generates the GridStack.js code to remove the specified widget.

private async removeWidget(params: RemoveWidgetParams): Promise<string> {
  const { el, removeDOM = true, triggerEvent = true } = params;

  return this.utils.generateGridStackCode("removeWidget", {
    element: el,
    removeDOM,
    triggerEvent,
    code: `grid.removeWidget('${String(
      el
    )}', ${removeDOM}, ${triggerEvent});`,
  });
}

src/tools/index.ts:181-200 (schema)

Input schema definition for the 'gridstack_remove_widget' tool, defining parameters el, removeDOM, and triggerEvent.

inputSchema: {
  type: "object",
  required: ["el"],
  properties: {
    el: {
      type: "string",
      description: "Widget selector or ID to remove",
    },
    removeDOM: {
      type: "boolean",
      description: "Remove from DOM as well",
      default: true,
    },
    triggerEvent: {
      type: "boolean",
      description: "Trigger 'removed' event",
      default: true,
    },
  },
},

src/tools/index.ts:774-775 (registration)
Registration in the callTool switch statement, dispatching to the removeWidget handler.
```
case "gridstack_remove_widget":
  return this.removeWidget(args as RemoveWidgetParams);
```

src/tools/index.ts:178-201 (registration)

Tool registration in the listTools() method, including name, description, and schema.

{
  name: "gridstack_remove_widget",
  description: "Remove a widget from the grid",
  inputSchema: {
    type: "object",
    required: ["el"],
    properties: {
      el: {
        type: "string",
        description: "Widget selector or ID to remove",
      },
      removeDOM: {
        type: "boolean",
        description: "Remove from DOM as well",
        default: true,
      },
      triggerEvent: {
        type: "boolean",
        description: "Trigger 'removed' event",
        default: true,
      },
    },
  },
},

src/types.ts:183-187 (schema)

TypeScript interface definition for RemoveWidgetParams used in the handler.

export interface RemoveWidgetParams {
  el: string | HTMLElement;
  removeDOM?: boolean;
  triggerEvent?: boolean;
}

GridStack MCP Server