Skip to content

docs(grid): Add additional info and ensure consistency with code examples #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 4, 2025
Merged

docs(grid): Add additional info and ensure consistency with code examples #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c24687d
add additional info
lzeiml Oct 28, 2025
25abfd7
fix
lzeiml Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/components/grid/code.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,22 @@ npm install @siemens/ix-aggrid
Import and configure the IX theme:

```javascript
import { useIxTheme } from '@siemens/ix-aggrid';
import { getIxTheme } from '@siemens/ix-aggrid';
import { provideGlobalGridOptions } from 'ag-grid-community';

const ixTheme = await useIxTheme(() => import('ag-grid-community'));
// Get iX theme based on your ag-grid module
const ixTheme = await getIxTheme(() => import('ag-grid-community'));

// Set the theme in your grid options
const gridOptions = {
theme: ixTheme,
// Rest of options
};

// Or set the theme globally for all grids
// Make sure to do this before initializing any grid
provideGlobalGridOptions({
theme: ixTheme
theme: ixTheme,
});
```

Expand Down
13 changes: 11 additions & 2 deletions docs/home/migration/4_0_0/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,11 +229,20 @@ Migration steps:

3. Configure the theme using the new theming API
```javascript
import { useIxTheme } from '@siemens/ix-aggrid';
import { getIxTheme } from '@siemens/ix-aggrid';
import { provideGlobalGridOptions } from 'ag-grid-community';

const ixTheme = await useIxTheme(() => import('ag-grid-community'));
// Get iX theme based on your ag-grid module
const ixTheme = await getIxTheme(() => import('ag-grid-community'));

// Set the theme in your grid options
const gridOptions = {
theme: ixTheme,
// Rest of options
};

// Or set the theme globally for all grids
// Make sure to do this before initializing any grid
provideGlobalGridOptions({
theme: ixTheme,
});
Expand Down