Skip to content

Included missing sections and added more detailed setup snippets in Grid Lite Overiview Topic #1887

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

Open
MarielaTihova wants to merge 1 commit into
base: vnext
Choose a base branch
from
Open

Included missing sections and added more detailed setup snippets in Grid Lite Overiview Topic #1887

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 34 additions & 24 deletions doc/en/components/grid-lite/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,53 +44,63 @@ yarn add igniteui-grid-lite

In the file where you want to use Grid Lite, import and register it before your component class or function is declared:

<!-- React -->
```tsx
```ts
import { IgcGridLite } from 'igniteui-grid-lite';

IgcGridLite.register();
```
<!-- End: React -->

<!-- WebComponents -->
```ts
```tsx
import { IgcGridLite } from 'igniteui-grid-lite';

IgcGridLite.register();
```
<!-- End: WebComponents -->

<!-- WebComponents -->
Get the element from the HTML in your TypeScript file by id:

```ts
const gridLite = document.getElementById('grid-lite') as IgcGridLite<ProductInfo>;
```
<!-- end: WebComponents -->

Add the `<igc-grid-lite>` element to your markup:

<!-- React -->
<!-- end: React, WebComponents -->

```tsx
const data = [
{ name: "John", age: 30, city: "New York" },
{ name: "Jane", age: 25, city: "Los Angeles" },
{ name: "Bob", age: 35, city: "Chicago" }
]

return (
<div className="container sample ig-typography">
<div className="grid-lite-wrapper">
<igc-grid-lite ref={this.gridRef} id="grid-lite"></igc-grid-lite>
</div>
</div>
<igc-grid-lite data={data} auto-generate={true}>
<igc-grid-lite-column field="name" header="Name"></igc-grid-lite-column>
<igc-grid-lite-column field="age" header="Age" data-type="number"></igc-grid-lite-column>
<igc-grid-lite-column field="city" header="City"></igc-grid-lite-column>
</igc-grid-lite>
);
```
<!-- end: React -->

<!-- WebComponents -->
```ts
private data = [
{ name: "John", age: 30, city: "New York" },
{ name: "Jane", age: 25, city: "Los Angeles" },
{ name: "Bob", age: 35, city: "Chicago" }
];

constructor() {
const gridLite = document.getElementById('grid-lite') as any;
gridLite.data = this.data;
}
```

```html
<div class="grid-lite-wrapper">
<igc-grid-lite id="grid-lite"></igc-grid-lite>
<div id="root">
<igc-grid-lite id="grid-lite" auto-generate="true">
<igc-grid-lite-column field="name" header="Name"></igc-grid-lite-column>
<igc-grid-lite-column field="age" header="Age" data-type="number"></igc-grid-lite-column>
<igc-grid-lite-column field="city" header="City"></igc-grid-lite-column>
</igc-grid-lite>
</div>
```
<!-- end: WebComponents -->

<!-- end: React, WebComponents -->

<!-- Blazor -->
### Install IgniteUI.Blazor.GridLite
Expand Down