Skip to content

Commit

Permalink
Minor readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
minht11 committed Jul 4, 2021
1 parent d03fc38 commit c468db6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,14 @@ Efficient, single direction virtual list/grid for Solid-js
* Keyboard navigation and focus management out of the box.
* Option to change items size based on available space.

[Demo](https://codesandbox.io/s/friendly-darkness-pk74r)
[Demo](https://codesandbox.io/s/minht11solid-virtual-container-demo-pk74r)

## Usage

```
npm install @minht11/solid-virtual-container
```

Create list item component.
```tsx
const ListItem = (props) => (
Expand All @@ -26,6 +31,8 @@ const ListItem = (props) => (
```
Create vertically scrolling virtual list
```tsx
import { VirtualContainer } from "@minht11/solid-virtual-container"

const App = () => {
const items = [0, 1, 2, 3]
let scrollTargetElement!: HTMLDivElement
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@minht11/solid-virtual-container",
"version": "0.1.0",
"version": "0.1.1",
"description": "Virtual list/grid for Solid-js.",
"author": "Justinas Delinda",
"license": "MIT",
Expand Down

0 comments on commit c468db6

Please sign in to comment.