@alaarab/ogrid-mcp 2.9.0 → 2.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/bundled-docs/api/README.md +7 -32
  2. package/bundled-docs/api/column-def.mdx +1 -1
  3. package/bundled-docs/api/components-column-chooser.mdx +0 -96
  4. package/bundled-docs/api/components-column-header-filter.mdx +1 -83
  5. package/bundled-docs/api/components-datagrid-table.mdx +0 -63
  6. package/bundled-docs/api/components-pagination-controls.mdx +0 -94
  7. package/bundled-docs/api/components-sidebar.mdx +0 -76
  8. package/bundled-docs/api/components-status-bar.mdx +0 -66
  9. package/bundled-docs/api/headless-hooks.mdx +410 -0
  10. package/bundled-docs/api/ogrid-props.mdx +1 -1
  11. package/bundled-docs/api/types.mdx +1 -1
  12. package/bundled-docs/features/cell-references.mdx +2 -116
  13. package/bundled-docs/features/column-chooser.mdx +0 -131
  14. package/bundled-docs/features/column-groups.mdx +1 -136
  15. package/bundled-docs/features/column-pinning.mdx +1 -108
  16. package/bundled-docs/features/column-reordering.mdx +1 -168
  17. package/bundled-docs/features/column-types.mdx +0 -71
  18. package/bundled-docs/features/context-menu.mdx +1 -93
  19. package/bundled-docs/features/csv-export.mdx +1 -104
  20. package/bundled-docs/features/editing.mdx +0 -149
  21. package/bundled-docs/features/filtering.mdx +0 -119
  22. package/bundled-docs/features/formulas.mdx +2 -102
  23. package/bundled-docs/features/grid-api.mdx +1 -108
  24. package/bundled-docs/features/keyboard-navigation.mdx +1 -74
  25. package/bundled-docs/features/mobile-touch.mdx +0 -71
  26. package/bundled-docs/features/pagination.mdx +0 -105
  27. package/bundled-docs/features/performance.mdx +0 -191
  28. package/bundled-docs/features/premium-inputs.mdx +0 -311
  29. package/bundled-docs/features/responsive-columns.mdx +1 -76
  30. package/bundled-docs/features/row-selection.mdx +2 -106
  31. package/bundled-docs/features/server-side-data.mdx +1 -129
  32. package/bundled-docs/features/sidebar.mdx +1 -78
  33. package/bundled-docs/features/sorting.mdx +2 -108
  34. package/bundled-docs/features/spreadsheet-selection.mdx +2 -79
  35. package/bundled-docs/features/status-bar.mdx +1 -72
  36. package/bundled-docs/features/toolbar.mdx +1 -75
  37. package/bundled-docs/features/virtual-scrolling.mdx +1 -304
  38. package/bundled-docs/getting-started/headless-or-component.mdx +112 -0
  39. package/bundled-docs/getting-started/installation.mdx +11 -141
  40. package/bundled-docs/getting-started/overview.mdx +15 -55
  41. package/bundled-docs/getting-started/quick-start.mdx +4 -279
  42. package/bundled-docs/guides/browser-support-matrix.mdx +6 -17
  43. package/bundled-docs/guides/mcp-live-testing.mdx +0 -82
  44. package/bundled-docs/guides/mcp.mdx +4 -4
  45. package/bundled-docs/guides/migration-from-ag-grid.mdx +2 -3
  46. package/bundled-docs/guides/theming.mdx +50 -23
  47. package/dist/esm/index.js +9 -39
  48. package/package.json +5 -5
  49. package/bundled-docs/api/js-api.mdx +0 -198
  50. package/bundled-docs/getting-started/vanilla-js.mdx +0 -218
  51. package/bundled-docs/guides/framework-showcase.mdx +0 -246
@@ -1,246 +0,0 @@
1
- ---
2
- sidebar_position: 5
3
- title: Framework Showcase
4
- description: OGrid in React, Angular, Vue, and Vanilla JS — shared core, native components
5
- ---
6
-
7
-
8
- # Framework Showcase
9
-
10
- OGrid works with your existing design system — not against it. React, Angular, Vue, and Vanilla JS are all fully supported, and every framework shares the same headless core so most behavior stays aligned across them.
11
-
12
- Every grid below is live. Core interactions like sorting, filtering, editing, and selection are wired up across the demos, and the current browser verification split is documented in the [Browser Support Matrix](./browser-support-matrix).
13
-
14
- ---
15
-
16
- ## Picking the right package
17
-
18
- The short version:
19
-
20
- - **Starting from scratch?** Pick the Radix variant for your framework — it's the lightest, with no peer dependencies beyond the framework itself.
21
- - **Already using a design system?** Pick the matching package — Fluent, Material, Angular Material, PrimeNG, Vuetify, or PrimeVue — and the grid components will use your existing components for buttons, inputs, and popovers.
22
- - **No framework?** Use `@alaarab/ogrid-js` for a full-featured grid with just a CDN import.
23
-
24
- Switching between UI libraries later is straightforward — you change the import and the wrapper provider if required. The grid configuration (columns, data, event handlers) doesn't change.
25
-
26
- ---
27
-
28
- ## React
29
-
30
- Three design systems, all sharing the same hooks from `@alaarab/ogrid-react`. Your column definitions, event handlers, and grid API calls work identically across all three.
31
-
32
- ### Radix UI — lightweight default
33
-
34
- The default React package. Radix primitives are bundled in — no separate peer dependency to install. It's a good starting point for new projects or when you want minimal overhead.
35
-
36
- ```bash
37
- npm install @alaarab/ogrid-react-radix
38
- ```
39
-
40
- ```tsx
41
-
42
- export default function App() {
43
- return (
44
- <OGrid
45
- columns={columns}
46
- data={data}
47
- getRowId={(row) => row.id}
48
- statusBar
49
- />
50
- );
51
- }
52
- ```
53
-
54
- <ShowcaseRadixDemo />
55
-
56
- ### Fluent UI — Microsoft ecosystem
57
-
58
- If you're building for Microsoft Teams, SharePoint, or any Microsoft 365 integration, Fluent is your pick. The grid uses native Fluent components for headers, filters, and inputs so it blends naturally.
59
-
60
- ```bash
61
- npm install @alaarab/ogrid-react-fluent @fluentui/react-components
62
- ```
63
-
64
- ```tsx
65
-
66
- export default function App() {
67
- return (
68
- <FluentProvider theme={webLightTheme}>
69
- <OGrid columns={columns} data={data} getRowId={(row) => row.id} />
70
- </FluentProvider>
71
- );
72
- }
73
- ```
74
-
75
- <ShowcaseFluentDemo />
76
-
77
- ### Material UI — Google's Material Design
78
-
79
- If your app already uses MUI, this drops right in. The grid uses MUI components and respects your `ThemeProvider` — including custom palettes and typography.
80
-
81
- ```bash
82
- npm install @alaarab/ogrid-react-material @mui/material @emotion/react @emotion/styled
83
- ```
84
-
85
- ```tsx
86
-
87
- const theme = createTheme({ palette: { primary: { main: '#6750a4' } } });
88
-
89
- export default function App() {
90
- return (
91
- <ThemeProvider theme={theme}>
92
- <OGrid columns={columns} data={data} getRowId={(row) => row.id} />
93
- </ThemeProvider>
94
- );
95
- }
96
- ```
97
-
98
- <ShowcaseMaterialDemo />
99
-
100
- ---
101
-
102
- ## Angular
103
-
104
- Signals-based reactivity with standalone components — no NgModule, no boilerplate. All three packages share the same services from `@alaarab/ogrid-angular`.
105
-
106
- ### Radix (Angular CDK) — lightweight default
107
-
108
- Angular CDK handles overlays (dropdowns, popovers) with no heavy UI framework required. Good default for new Angular projects.
109
-
110
- ```bash
111
- npm install @alaarab/ogrid-angular-radix @angular/cdk
112
- ```
113
-
114
- ```typescript
115
-
116
- @Component({
117
- standalone: true,
118
- imports: [OGridComponent],
119
- template: `<ogrid [props]="gridProps" />`
120
- })
121
- export class GridComponent {
122
- gridProps = { columns, data, getRowId: (row) => row.id };
123
- }
124
- ```
125
-
126
- ### Angular Material
127
-
128
- If you're already on Angular Material, the grid components match your existing theme automatically.
129
-
130
- ```bash
131
- npm install @alaarab/ogrid-angular-material @angular/material @angular/cdk
132
- ```
133
-
134
- ```typescript
135
- // Same props — just change the import
136
- ```
137
-
138
- ### PrimeNG
139
-
140
- For teams in the PrimeFaces ecosystem, PrimeNG integration means dialogs, dropdowns, and inputs all look native.
141
-
142
- ```bash
143
- npm install @alaarab/ogrid-angular-primeng primeng
144
- ```
145
-
146
- ```typescript
147
- // Same props — just change the import
148
- ```
149
-
150
- ---
151
-
152
- ## Vue
153
-
154
- Composition API composables built with `ref()` and `computed()`. All three packages share composables from `@alaarab/ogrid-vue`.
155
-
156
- ### Radix (Headless UI) — lightweight default
157
-
158
- Headless UI Vue components bundled in — no peer dependencies beyond Vue 3. Good starting point for new Vue projects.
159
-
160
- ```bash
161
- npm install @alaarab/ogrid-vue-radix
162
- ```
163
-
164
- ```vue
165
- <script setup lang="ts">
166
-
167
- const gridProps = { columns, data, getRowId: (row) => row.id };
168
- </script>
169
-
170
- <template>
171
- <OGrid :gridProps="gridProps" />
172
- </template>
173
- ```
174
-
175
- ### Vuetify
176
-
177
- If your app is built on Vuetify 3, the grid's buttons, selects, and inputs all use Vuetify components and adopt your existing theme.
178
-
179
- ```bash
180
- npm install @alaarab/ogrid-vue-vuetify vuetify
181
- ```
182
-
183
- ```vue
184
- <script setup lang="ts">
185
- // Same gridProps — just change the import, wrap in <v-app> for theming
186
- </script>
187
- ```
188
-
189
- ### PrimeVue
190
-
191
- PrimeVue 4 integration for teams already on the PrimeFaces stack.
192
-
193
- ```bash
194
- npm install @alaarab/ogrid-vue-primevue primevue
195
- ```
196
-
197
- ```vue
198
- <script setup lang="ts">
199
- // Same gridProps — just change the import
200
- </script>
201
- ```
202
-
203
- ---
204
-
205
- ## Vanilla JS / TypeScript
206
-
207
- No framework, no virtual DOM — just a container element and a class constructor. A built-in CSS theme covers light and dark mode with CSS custom properties you can override.
208
-
209
- ```bash
210
- npm install @alaarab/ogrid-js
211
- ```
212
-
213
- <VanillaJSDemo />
214
-
215
- ---
216
-
217
- ## At a glance
218
-
219
- | Framework | Design Systems | Reactivity model |
220
- |-----------|----------------|-----------------|
221
- | **React** 17–19 | Radix *(bundled)* · Fluent UI v9 · MUI v7 | Hooks |
222
- | **Angular** 21 | Radix (CDK) *(default)* · Angular Material · PrimeNG | Signals |
223
- | **Vue** 3.3+ | Radix (Headless UI) *(bundled)* · Vuetify 3 · PrimeVue 4 | Composition API |
224
- | **Vanilla JS/TS** | Built-in CSS theme *(zero deps)* | EventEmitter |
225
-
226
- All 10 packages share the same `@alaarab/ogrid-core`. Shared test factories cover the common contract, and package-specific browser coverage handles the remaining interaction differences. Switching design systems within a framework family is usually a one-line import change.
227
-
228
- ## Premium inputs (optional)
229
-
230
- Each framework has an optional inputs package with advanced cell editors: calendar date pickers, sliders, color pickers, ratings, and tag inputs. They're tree-shakeable and have no impact on bundle size unless you use them.
231
-
232
- | Framework | Package |
233
- |-----------|---------|
234
- | React | `@alaarab/ogrid-react-inputs` |
235
- | Angular | `@alaarab/ogrid-angular-inputs` |
236
- | Vue | `@alaarab/ogrid-vue-inputs` |
237
- | Vanilla JS | `@alaarab/ogrid-js-inputs` |
238
-
239
- See [Premium Inputs](../features/premium-inputs) for usage and the full list of available editors.
240
-
241
- ## Related
242
-
243
- - [Quick Start](../getting-started/quick-start) — get a grid running in 60 seconds
244
- - [Vanilla JS Guide](../getting-started/vanilla-js) — full JS API documentation
245
- - [Theming Guide](./theming) — customize colors and styling
246
- - [Premium Inputs](../features/premium-inputs) — advanced cell editors