jquery - Throttle scroll event to add box-shadow -

when scroll element on page, add shadow specified element visually show user page scrolled, when viewing long lists.

# html <header id="header">   header... </div> <main data-behavior="scroll-shadow" data-scroll-shadow-element="#header">   ... </main>  # coffeescript using jquery $("[data-behavior~='scroll-shadow']").on "scroll", (e) ->   $trigger = $(this)   $target = $($trigger.attr("data-scroll-shadow-element"))    if $trigger.scrolltop()     $target.addclass("scroll-shadow-active")   else     $target.removeclass("scroll-shadow-active") 

this code works fine, , adds/removes css class shows box-shadow.

however, know attaching events scroll bad idea performance reasons.

as looking this, though, came across few different solutions , wasn't sure best type of use-case.

debouce

seems possible, grab group of scroll events , fire handler once groups doesn't fire every time. however, seems solution wouldn't add styled shadow until user stops scrolling. if user scrolled top bottom of long list, wouldn't see shadow until several seconds later.

throttle

this seems better way go, execute set number of events instead of every 1 (maybe 1/4 of scroll events trigger handler).

---

since i'm not javascript performance expert of sort, wasn't sure better option be. i'm looking @ using lodash js utility library since have tested code throttling/etc.

is throttling best solution performance wise particular type of event handling? ways add shadows scrolled elements in performant fashion?

how understand "debouncing events" selective on these... instead of taking them all.

on scroll, take first event , ignore others.
that, in performance perspective... because, here, addclass(). else repeatedly call bad.

so use "flag" or counter here.

then, settimeout() resets flag or timer when user has finished scrolling.

var shadowtarget;  var scrolltimeout;  var eventcount=0;  $("[data-behavior~='scroll-shadow']").on("scroll", function(){      eventcount++;    if(eventcount==1){      trigger = $(this);      shadowtarget = $(trigger.attr("data-scroll-shadow-element"));        console.log("adding class.");      shadowtarget.addclass("scroll-shadow-active");    }      // setting new timeout @ each scroll event.    cleartimeout(scrolltimeout);    scrolltimeout = settimeout(function(){      console.log("removing class.");      shadowtarget.removeclass("scroll-shadow-active");      eventcount=0;    },500);      });

header{    background-color: cyan;  }  main{    overflow-y: scroll;    height:600px;  }  .scroll-shadow-active{    border: 1px solid red;    box-shadow: 4px 4px 3px red;  }

<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>      <header id="header">    header...  </header>  <main data-behavior="scroll-shadow" data-scroll-shadow-element="#header">    <p>      lorem ipsum dolor sit amet, consectetur adipiscing elit. aenean sollicitudin leo eu bibendum aliquam. curabitur aliquet eros lectus, et molestie nisi tempor vel. quisque mollis, sapien hendrerit accumsan pellentesque, quam quam vestibulum orci, nec ornare diam turpis ut purus. cras ut quam ut nibh sollicitudin scelerisque. nunc volutpat mauris sed porta lacinia. vivamus pharetra eget tortor nec venenatis. vivamus nec velit ut felis consectetur ullamcorper. suspendisse id dictum enim. nulla ut volutpat nisi, vitae tempor diam. proin mattis dui ante, fermentum lacinia ex vulputate at. donec tristique eget urna vel convallis. mauris ac elit ut orci pretium faucibus ac sit amet justo.    </p>    <p>      suspendisse gravida sodales lorem, sit amet posuere nunc semper et. proin euismod @ arcu in suscipit. quisque eu efficitur nunc, quis hendrerit orci. mauris erat quis ante aliquam imperdiet posuere ac dui. nam sit amet consectetur nunc. donec risus ex, convallis eget orci tristique, rhoncus auctor tortor. aliquam sit amet fermentum nisl. morbi vel ipsum et nisl tristique fringilla nec sed ipsum. aenean aliquet purus id bibendum tempus. suspendisse auctor pretium augue, tincidunt sapien vehicula quis. ut eu sagittis turpis. nulla rhoncus felis nibh, in viverra magna sagittis congue. integer tempus ultricies viverra. sed aliquet velit.    </p>    <p>      cras sagittis, dolor accumsan commodo condimentum, tellus lorem bibendum diam, in consequat augue quam nec est. quisque id eros tortor. ut ex risus, vehicula quis cursus a, efficitur convallis erat. maecenas egestas lobortis maximus. phasellus varius, ipsum in maximus ultrices, orci lectus tincidunt magna, vel vestibulum urna turpis ac leo. nulla nulla massa, consequat non vulputate imperdiet, volutpat dapibus orci. etiam consequat volutpat est, id tempus turpis venenatis vitae. praesent arcu erat, porta molestie neque non, ultrices dignissim sem. suspendisse potenti. duis nec mauris commodo libero maximus egestas. sed laoreet maximus tellus semper accumsan.    </p>    <p>      in hendrerit molestie blandit. in hac habitasse platea dictumst. nullam in ipsum urna. maecenas in ante nisi. integer porta molestie enim, sit amet scelerisque mauris fringilla elementum. phasellus @ elit mattis, scelerisque ligula et, imperdiet leo. suspendisse nec dignissim augue. cras neque turpis, tempus vel tortor sit amet, commodo laoreet augue. aliquam ac dui vel lorem facilisis tristique non non urna. cras pharetra mauris id aliquet luctus. morbi sit amet felis lectus maximus lacinia. sed quam elit, imperdiet eu rhoncus in, scelerisque sed arcu. aliquam feugiat ultrices finibus. suspendisse semper risus, gravida laoreet lacus. in fermentum auctor volutpat. nullam egestas, lorem eget imperdiet semper, elit nisl aliquet neque, nec mollis erat lacus ut nibh.    </p>    <p>      ut sit amet ex iaculis, vestibulum urna id, dictum elit. nunc semper semper lacus @ feugiat. nam viverra orci vel risus vulputate, sed fringilla turpis ultrices. vivamus pulvinar, mi in bibendum scelerisque, nunc augue laoreet sem, vitae posuere ipsum mauris vel turpis. aliquam quis nulla maximus ligula eleifend aliquet ut neque. cras lobortis id ante quis sagittis. lorem ipsum dolor sit amet, consectetur adipiscing elit. in maximus quam @ rhoncus venenatis. sed tempus nec urna vel tempus. mauris aliquam, risus id mollis commodo, dolor tortor porta augue, in consequat purus velit nec ante.    </p>    <p>      proin tempus pharetra nisl ut rhoncus. fusce dapibus tincidunt lobortis. donec dolor nisi, posuere ut ullamcorper a, molestie ut enim. sed quis felis accumsan, pellentesque nunc at, vestibulum dolor. pellentesque quis ex nec ex tincidunt sodales. pellentesque eget justo nisl. nullam rutrum ligula sed libero tempor ullamcorper. class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. nullam enim felis, cursus sed sem a, gravida consectetur diam. ut accumsan diam ut tempor fringilla. etiam @ ex lacus. morbi tortor mauris, blandit sed mi ut, eleifend tempus magna.    </p>    <p>      maecenas @ rutrum ante. aenean eu sapien in sem hendrerit facilisis dictum vel sem. ut laoreet ligula quis risus congue commodo. donec tempor, turpis sollicitudin vulputate auctor, nunc mi maximus lectus, ornare lobortis metus neque nibh. orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. sed id tempor purus. donec ipsum mauris, molestie @ posuere non, scelerisque ac massa. etiam scelerisque tempus ante, finibus dictum ante gravida eget. suspendisse convallis risus vel velit ornare, vitae aliquam purus dictum. nullam suscipit magna tellus, accumsan elit viverra in. etiam rutrum turpis non lorem condimentum viverra.    </p>    <p>      maecenas cursus eros sed urna laoreet pulvinar. sed consectetur felis, consectetur gravida enim. etiam varius ac ligula vel ultrices. proin et lectus euismod, molestie purus ut, hendrerit mi. suspendisse lobortis ipsum sem. quisque nec augue quis lectus egestas consequat. donec in arcu in mi feugiat congue. nam porta augue venenatis diam auctor, quis aliquam dolor pulvinar. sed vitae nibh nec ligula congue facilisis ac eget felis. vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; praesent tellus arcu, commodo vestibulum et, pulvinar vel lacus.    </p>    <p>      quisque vel elit vitae turpis sollicitudin fringilla. quisque iaculis dignissim sodales. vivamus in nisi id turpis commodo pretium ornare ac enim. nulla eu ex lobortis, lacinia mauris sed, consectetur diam. donec @ metus vel metus tincidunt blandit. donec molestie purus quis sapien rhoncus euismod. donec gravida, nunc quis consequat ornare, augue leo vestibulum eros, ac euismod lectus ex non mi.    </p>    <p>      vestibulum quis libero sed risus consectetur porttitor sed quis nunc. duis malesuada erat posuere erat suscipit, nec commodo augue faucibus. nulla euismod diam eget sollicitudin fermentum. sed ullamcorper tempus augue et tempus. mauris non neque justo. aenean tristique mauris nibh, sit amet lobortis est tristique ut. aliquam nibh ex, varius vel consequat nec, vehicula non turpis.    </p>  </main>

as can see... there no more 1 "adding class." in console.
;)