@hookify/react-virtualization-hook
TypeScript icon, indicating that this package has built-in type declarations

0.3.0 • Public • Published

@hookify/react-virtualization-hook

React Hook for making optimized lists

Installation

Installing using node package manager. Type the following in your console inside your project directory:

npm install @hookify/react-virtualization-hook --save

With yarn:

yarn add @hookify/react-virtualization-hook

Usage

import * as React from 'react'
import { useVirtualList } from '@hookify/react-virtualization-hook'

const VirtualList: React.FC = () => {
  const {
    state,
    containerProps,
    wrapperProps
  } = useVirtualList({
    itemHeight: 51,
    totalItems: 40,
    showOffscreenBottom: 3,
    showOffscreenTop: 3
  })
  const items = Array.from(new Array(state.shownTo - state.shownFrom + 1).keys())
  return (
    <div className="virtual-list-container" {...containerProps()}>
      <div {...wrapperProps()}>
        {items.map((i) => (
          <p key={state.shownFrom + i}>item #{state.shownFrom + i}</p>
        ))}
      </div>
    </div>
  )
}

Readme

Keywords

none

Package Sidebar

Install

npm i @hookify/react-virtualization-hook

Weekly Downloads

1

Version

0.3.0

License

MIT

Unpacked Size

13.3 kB

Total Files

8

Last publish

Collaborators

  • iamawebgeek