@toolbox-web/grid 0.2.2 → 0.2.4

package/README.md

@@ -126,6 +126,30 @@ When the same property is set via multiple methods, higher precedence wins:
 <tbw-grid></tbw-grid>
 ```
 
+### HTML Attributes
+
+The grid supports configuration via HTML attributes with JSON-serialized values:
+
+| Attribute     | Type   | Description                                 |
+| ------------- | ------ | ------------------------------------------- |
+| `rows`        | JSON   | Data array (JSON-serialized)                |
+| `columns`     | JSON   | Column definitions (JSON-serialized)        |
+| `grid-config` | JSON   | Full configuration object (JSON-serialized) |
+| `fit-mode`    | string | Column sizing: `'stretch'` or `'fixed'`     |
+| `edit-on`     | string | Edit trigger: `'click'` or `'dblclick'`     |
+
+**Example with HTML attributes:**
+
+```html
+<tbw-grid
+  rows='[{"id":1,"name":"Alice"},{"id":2,"name":"Bob"}]'
+  columns='[{"field":"id","header":"ID"},{"field":"name","header":"Name"}]'
+  fit-mode="stretch"
+  edit-on="dblclick"
+>
+</tbw-grid>
+```
+
 ### Properties
 
 | Property     | Type                    | Description                                        |
@@ -423,6 +447,52 @@ export class MyPlugin extends BaseGridPlugin<MyPluginConfig> {
 }
 ```
 
+### Inter-Plugin Communication
+
+Plugins can communicate with each other using the generic query system. This allows plugins to expose capabilities or constraints without the core knowing about specific plugin concepts.
+
+**Responding to queries (in your plugin):**
+
+```typescript
+import { BaseGridPlugin, PLUGIN_QUERIES, PluginQuery } from '@toolbox-web/grid';
+
+export class MyPlugin extends BaseGridPlugin<MyConfig> {
+  override onPluginQuery(query: PluginQuery): unknown {
+    switch (query.type) {
+      case PLUGIN_QUERIES.CAN_MOVE_COLUMN:
+        // Veto column movement for locked columns
+        const column = query.context as ColumnConfig;
+        if (this.isLocked(column)) return false;
+        return undefined; // Let other plugins decide
+      default:
+        return undefined;
+    }
+  }
+}
+```
+
+**Querying other plugins:**
+
+```typescript
+import { PLUGIN_QUERIES } from '@toolbox-web/grid';
+
+// In your plugin or application code
+const responses = grid.queryPlugins<boolean>({
+  type: PLUGIN_QUERIES.CAN_MOVE_COLUMN,
+  context: column,
+});
+const canMove = !responses.includes(false);
+```
+
+**Built-in query types:**
+
+| Query Type               | Context             | Response            | Description                     |
+| ------------------------ | ------------------- | ------------------- | ------------------------------- |
+| `CAN_MOVE_COLUMN`        | `ColumnConfig`      | `boolean`           | Can the column be reordered?    |
+| `GET_CONTEXT_MENU_ITEMS` | `ContextMenuParams` | `ContextMenuItem[]` | Get menu items for context menu |
+
+Plugins can also define custom query types for their own inter-plugin communication.
+
 ### Accessing Plugin Instances
 
 Use `grid.getPlugin()` to get a plugin instance for inter-plugin communication or API access: