Skip to content

Update README with dummy data and import components #1158

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README with dummy data and import components #1158

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
28 changes: 23 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,35 @@ You may also need to install the peer dependencies if you don't have them alread
npm i lodash marked react-responsive-carousel
```

Import Grid and mandatory CSS:

```ts
import DataEditor, { GridColumn, GridCell, Item } from "@glideapps/glide-data-grid";
import "@glideapps/glide-data-grid/dist/index.css";
```

Add dummy data:
```shell
const data = [
{
firstName: "John",
lastName: "Doe"
},
{
firstName: "John",
lastName: "Wick"
}
];

const numRows = data.length;
```

Create a new `DataEditor` wherever you need to display lots and lots of data

```tsx
<DataEditor getCellContent={getData} columns={columns} rows={numRows} />
```

Don't forget to import mandatory CSS

```ts
import "@glideapps/glide-data-grid/dist/index.css";
```

Making your columns is easy

Expand Down