Sigma ScrollKit

Advanced virtual scrolling module for Vue 3.

Originally created for the parent project: Sigma File Manager v2.

Features

• List view
• Grid view
• Arbitrary item height
• Spacers
• Dividers
• Support for custom scrollbars
• Events
• Slots

Supporters

Your logo here

Consider supporting my work

Platform	Address
Patreon (monthly, with rewards) By joining, you will get all rewards of the related parent project: Sigma File Manager
Buymeacoffee
BTC	bc1qv5ujcuwjsk505qjhd3sptcf3xpvjktqjxj0wrc
USDT (Tron TRC-20)	TN3hFLmjY2eXR149yKMq1qZQotmZbTGV4a

Installation

npm install sigma-scrollkit

VirtualScroller | Props

virtualEntries

• Required: true
• Type: VirtualEntry[]

scrollerId

• Required: true
• Type: string

layoutType

• Required: true
• Type: 'list' | 'grid'

minColumnWidth

• Required: false
• Type: number

bufferItemCount

• Required: false
• Type: number

calcExtraInfo

• Required: false
• Type: boolean
• Description: if true, extra data properties will be calculated and emited in the scroll event:
  • scrollSpeed: current scroll speed

VirtualScroller | Events

viewport-mounted

• Type: {viewport: Ref<HTMLElement | null>; selector: string}

scroll

• Type: ScrollEmitValue

scrolling

• Type: boolean

is-scrollable

• Type: boolean

top-reached

• Type: boolean

bottom-reached

• Type: boolean

VirtualScrollerRow | Props

virtualEntry

• Required: true
• Type: VirtualEntry

maxColumns

• Required: true
• Type: number