1.0.1 • Published 6 years ago

preact-scroll-events v1.0.1

Weekly downloads
2
License
ISC
Repository
github
Last release
6 years ago

preact-scroll-events

MinMaxEvent : Adds onMaxReached and onMinReached events with a few extra variables to the nested component.

MinMaxEvent

offsetMaxBeta default: 100 when scroll reaches % of scrollable element from end ---->|..(100)%.. this event will be fired once. When the scroll is less than the max, then it will be able to fire again.

offsetMinBeta 100 when scroll reaches % of scrollable element from start ..(100)%..|<----

offsetMin 0 when scroll reaches distance in pixels from end ..(X)px..|<----

offsetMax 0 when scroll reaches distance in pixels start ---->|..(X)px..

vert true vertical of horizontal scroll?

onMaxReached null Event fired when scroll reaches max bottom/right

onMinReached null Event fired when scroll reaches min top/left

jsx

import {MinMaxEvent} from 'preact-scroll-events'

//......

render: function(){
	<MinMaxEvent vert=true offsetMinBeta=0 offsetMaxBeta=100 onMaxReached=this.onMaxReachedCallback onMinReached=this.onMinReachedCallback>
		<div style={overflowY:"scroll"}>Im scrollable, when my scroll reaches 100% of my height from bottom, one onMaxReached event will be fired</div>
	</MinMaxEvent>
}

coffeescript

{MinMaxEvent} = require('preact-scroll-events')

#.......

render: ->
	h MinMaxEvent,
		vert: true
		offsetMinBeta: 0
		offsetMaxBeta: 100
		onMaxReached: @onMaxReachedCallback
		onMinReached: @onMinReachedCallback
		h 'div',
			style:
				overflowY: 'scroll'
			'Im scrollable, when my scroll reaches 100% of my height from bottom, I will dispatch one onMaxReached event.'
1.0.1

6 years ago

1.0.0

6 years ago