Skip to content

README.md

Latest commit

 

History

History
61 lines (40 loc) · 1.66 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.66 KB

vvirtual-grid

A Vue 3 component for rendering massive lists as a CSS grid with virtual scrolling.

npm version license

Packages

This is a monorepo managed with pnpm workspaces.

Package Description
core/ The vvirtual-grid library — Vue component, Nuxt module, and utilities
docs/ Documentation site built with Docus
playground/ Local development playground

Getting Started

See the documentation or the core README for usage instructions.

Development

Prerequisites

Setup

pnpm install

Commands

Command Description
pnpm --filter=vvirtual-grid run build Build the library
pnpm --filter=vvirtual-grid run lint Lint the library source
pnpm run test Run all tests
pnpm --filter=playground run dev Start the Vue playground
pnpm --filter=docs run dev Start the documentation site locally

Contributing

  1. Fork the repo and create a branch from main.
  2. Make your changes in core/src/ or core/integrations/.
  3. Add or update tests as needed.
  4. Open a pull request — CI will run lint and tests automatically.

Credits

Special thanks goes to

License

MIT © astraldev