Home Explore Help
Register Sign In
wicresoft
/
doc_project
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: bf1fb50bbd
Branches Tags
doc_project
/
better-scroll-docs
/
en-US
/
guide
/
base-scroll-api.html

base-scroll-api.html 131 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en-US">
    3. 

  3.   <head>
    4. 

  4.     <meta charset="utf-8">
    5. 

  5.     <meta name="viewport" content="width=device-width,initial-scale=1">
    6. 

  6.     <title>API | BetterScroll 2.0</title>
    7. 

  7.     <meta name="generator" content="VuePress 1.9.10">
    8. 

  8.     <link rel="shortcut icon" href="/docs/assets/bs.ico" type="images/x-icon">
    9. 

  9.     <script src="https://www.googletagmanager.com/gtag/js?id=G-7E85TW7P27"></script>
    10. 

  10.     <script type="text/javascript">
    11. 

  11.       window.dataLayer = window.dataLayer || [];
    12. 

  12.       function gtag(){dataLayer.push(arguments);}
    13. 

  13.       gtag('js', new Date());
    14. 

  14.       gtag('config', 'G-7E85TW7P27');
    15. 

  15.     </script>
    16. 

  16.     <meta name="description" content="Make Scroll Perfect">
    17. 

  17.     
    18. 

  18.     <link rel="preload" href="/docs/assets/css/0.styles.0cd93813.css" as="style"><link rel="preload" href="/docs/assets/js/app.c71b64d3.js" as="script"><link rel="preload" href="/docs/assets/js/5.d6412664.js" as="script"><link rel="preload" href="/docs/assets/js/4.4855b9ef.js" as="script"><link rel="preload" href="/docs/assets/js/3.481632b4.js" as="script"><link rel="preload" href="/docs/assets/js/78.6d3ef23b.js" as="script"><link rel="preload" href="/docs/assets/js/7.518ccda7.js" as="script"><link rel="prefetch" href="/docs/assets/js/1.8644db92.js"><link rel="prefetch" href="/docs/assets/js/10.6f8c38eb.js"><link rel="prefetch" href="/docs/assets/js/100.ee08226e.js"><link rel="prefetch" href="/docs/assets/js/101.fd2f3d9f.js"><link rel="prefetch" href="/docs/assets/js/102.79d86e3d.js"><link rel="prefetch" href="/docs/assets/js/103.7a3ae3b5.js"><link rel="prefetch" href="/docs/assets/js/104.7be4589d.js"><link rel="prefetch" href="/docs/assets/js/105.75386d15.js"><link rel="prefetch" href="/docs/assets/js/106.a4a18e8d.js"><link rel="prefetch" href="/docs/assets/js/107.561ec2e2.js"><link rel="prefetch" href="/docs/assets/js/108.1c61689f.js"><link rel="prefetch" href="/docs/assets/js/109.da71a73e.js"><link rel="prefetch" href="/docs/assets/js/110.5e0fa2d1.js"><link rel="prefetch" href="/docs/assets/js/111.1e326dd1.js"><link rel="prefetch" href="/docs/assets/js/112.590ba317.js"><link rel="prefetch" href="/docs/assets/js/113.cf201ace.js"><link rel="prefetch" href="/docs/assets/js/114.6d895ce2.js"><link rel="prefetch" href="/docs/assets/js/115.572aee19.js"><link rel="prefetch" href="/docs/assets/js/116.754722a0.js"><link rel="prefetch" href="/docs/assets/js/117.15e4dab3.js"><link rel="prefetch" href="/docs/assets/js/118.721d68f8.js"><link rel="prefetch" href="/docs/assets/js/119.c5c28d96.js"><link rel="prefetch" href="/docs/assets/js/120.12cd2e0e.js"><link rel="prefetch" href="/docs/assets/js/121.e41f8100.js"><link rel="prefetch" href="/docs/assets/js/122.9ebe2f53.js"><link rel="prefetch" href="/docs/assets/js/123.f90c91f9.js"><link rel="prefetch" href="/docs/assets/js/13.b0c40cd7.js"><link rel="prefetch" href="/docs/assets/js/14.28bec126.js"><link rel="prefetch" href="/docs/assets/js/15.87b22af4.js"><link rel="prefetch" href="/docs/assets/js/16.c10e14e7.js"><link rel="prefetch" href="/docs/assets/js/17.5c921c77.js"><link rel="prefetch" href="/docs/assets/js/18.dc23b7e3.js"><link rel="prefetch" href="/docs/assets/js/19.a4034f95.js"><link rel="prefetch" href="/docs/assets/js/2.03f0f2c8.js"><link rel="prefetch" href="/docs/assets/js/20.8633fd45.js"><link rel="prefetch" href="/docs/assets/js/21.1fbf8d7e.js"><link rel="prefetch" href="/docs/assets/js/22.2888cfc5.js"><link rel="prefetch" href="/docs/assets/js/23.f951d302.js"><link rel="prefetch" href="/docs/assets/js/24.12842718.js"><link rel="prefetch" href="/docs/assets/js/25.5a5a3137.js"><link rel="prefetch" href="/docs/assets/js/26.88e81f0b.js"><link rel="prefetch" href="/docs/assets/js/27.152b8fda.js"><link rel="prefetch" href="/docs/assets/js/28.22550ea8.js"><link rel="prefetch" href="/docs/assets/js/29.f43fa807.js"><link rel="prefetch" href="/docs/assets/js/30.4ed38f67.js"><link rel="prefetch" href="/docs/assets/js/31.af4018f6.js"><link rel="prefetch" href="/docs/assets/js/32.930ee0b7.js"><link rel="prefetch" href="/docs/assets/js/33.c6a68c75.js"><link rel="prefetch" href="/docs/assets/js/34.6d10da1e.js"><link rel="prefetch" href="/docs/assets/js/35.11ba7b51.js"><link rel="prefetch" href="/docs/assets/js/36.8a54712b.js"><link rel="prefetch" href="/docs/assets/js/37.b26eb85d.js"><link rel="prefetch" href="/docs/assets/js/38.d6569a11.js"><link rel="prefetch" href="/docs/assets/js/39.1d22cfba.js"><link rel="prefetch" href="/docs/assets/js/40.577a94d7.js"><link rel="prefetch" href="/docs/assets/js/41.155e01e0.js"><link rel="prefetch" href="/docs/assets/js/42.3c26eaba.js"><link rel="prefetch" href="/docs/assets/js/43.d90991e2.js"><link rel="prefetch" href="/docs/assets/js/44.5437344c.js"><link rel="prefetch" href="/docs/assets/js/45.0d2eca0a.js"><link rel="prefetch" href="/docs/assets/js/46.11455b40.js"><link rel="prefetch" href="/docs/assets/js/47.1ee1a8f0.js"><link rel="prefetch" href="/docs/assets/js/48.c82450ab.js"><link rel="prefetch" href="/docs/assets/js/49.8016ee5f.js"><link rel="prefetch" href="/docs/assets/js/50.ab73e091.js"><link rel="prefetch" href="/docs/assets/js/51.bce6eb99.js"><link rel="prefetch" href="/docs/assets/js/52.c9b1992f.js"><link rel="prefetch" href="/docs/assets/js/53.7057f0f5.js"><link rel="prefetch" href="/docs/assets/js/54.cbb0a6b5.js"><link rel="prefetch" href="/docs/assets/js/55.89176a68.js"><link rel="prefetch" href="/docs/assets/js/56.cd04bae9.js"><link rel="prefetch" href="/docs/assets/js/57.c7a42e07.js"><link rel="prefetch" href="/docs/assets/js/58.09d6cb1b.js"><link rel="prefetch" href="/docs/assets/js/59.8445a09f.js"><link rel="prefetch" href="/docs/assets/js/6.5737c458.js"><link rel="prefetch" href="/docs/assets/js/60.86b1f417.js"><link rel="prefetch" href="/docs/assets/js/61.fa371ad1.js"><link rel="prefetch" href="/docs/assets/js/62.dbc75ddc.js"><link rel="prefetch" href="/docs/assets/js/63.a4465c93.js"><link rel="prefetch" href="/docs/assets/js/64.a39c3193.js"><link rel="prefetch" href="/docs/assets/js/65.a7275f82.js"><link rel="prefetch" href="/docs/assets/js/66.afd0af7d.js"><link rel="prefetch" href="/docs/assets/js/67.8009e00e.js"><link rel="prefetch" href="/docs/assets/js/68.de3c51dd.js"><link rel="prefetch" href="/docs/assets/js/69.41a50235.js"><link rel="prefetch" href="/docs/assets/js/70.938e9532.js"><link rel="prefetch" href="/docs/assets/js/71.af7fca59.js"><link rel="prefetch" href="/docs/assets/js/72.25df569a.js"><link rel="prefetch" href="/docs/assets/js/73.f16b7dc3.js"><link rel="prefetch" href="/docs/assets/js/74.d2184ed7.js"><link rel="prefetch" href="/docs/assets/js/75.9497b6fa.js"><link rel="prefetch" href="/docs/assets/js/76.2081d35e.js"><link rel="prefetch" href="/docs/assets/js/77.e5a8b470.js"><link rel="prefetch" href="/docs/assets/js/79.025583e1.js"><link rel="prefetch" href="/docs/assets/js/8.8547d4ad.js"><link rel="prefetch" href="/docs/assets/js/80.e7e3ef35.js"><link rel="prefetch" href="/docs/assets/js/81.569d569f.js"><link rel="prefetch" href="/docs/assets/js/82.ac3ed0f7.js"><link rel="prefetch" href="/docs/assets/js/83.3393dfc3.js"><link rel="prefetch" href="/docs/assets/js/84.e5352ac1.js"><link rel="prefetch" href="/docs/assets/js/85.c7cdb129.js"><link rel="prefetch" href="/docs/assets/js/86.0aa0af94.js"><link rel="prefetch" href="/docs/assets/js/87.0db12b1e.js"><link rel="prefetch" href="/docs/assets/js/88.e8651cfa.js"><link rel="prefetch" href="/docs/assets/js/89.1b58abde.js"><link rel="prefetch" href="/docs/assets/js/9.0a882dfc.js"><link rel="prefetch" href="/docs/assets/js/90.d65d2d13.js"><link rel="prefetch" href="/docs/assets/js/91.32b2ad41.js"><link rel="prefetch" href="/docs/assets/js/92.795675a1.js"><link rel="prefetch" href="/docs/assets/js/93.818e5569.js"><link rel="prefetch" href="/docs/assets/js/94.79c2b16e.js"><link rel="prefetch" href="/docs/assets/js/95.4810ee5e.js"><link rel="prefetch" href="/docs/assets/js/96.6e382fd5.js"><link rel="prefetch" href="/docs/assets/js/97.e270d7b5.js"><link rel="prefetch" href="/docs/assets/js/98.728ef6c2.js"><link rel="prefetch" href="/docs/assets/js/99.c75096e0.js"><link rel="prefetch" href="/docs/assets/js/vendors~docsearch.2091e099.js">
    19. 

  19.     <link rel="stylesheet" href="/docs/assets/css/0.styles.0cd93813.css">
    20. 

  20.   </head>
    21. 

  21.   <body>
    22. 

  22.     <div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/docs/en-US/" class="home-link router-link-active"><img src="https://dpubstatic.udache.com/static/dpubimg/t_L6vAgQ-E/logo.svg" alt="BetterScroll 2.0" class="logo"> <span class="site-name can-hide">BetterScroll 2.0</span></a> <div class="links"><form id="search-form" role="search" class="algolia-search-wrapper search-box"><input id="algolia-search-input" class="search-query"></form> <nav class="nav-links can-hide"><div class="nav-item"><a href="/docs/en-US/guide/" class="nav-link router-link-active">
    23. 

  23.   Guide
    24. 

  24. </a></div><div class="nav-item"><a href="/docs/en-US/plugins/" class="nav-link">
    25. 

  25.   Plugin
    26. 

  26. </a></div><div class="nav-item"><a href="/docs/en-US/FAQ/" class="nav-link">
    27. 

  27.   FAQ
    28. 

  28. </a></div><div class="nav-item"><a href="https://github.com/ustbhuangyi/better-scroll/issues" target="_blank" rel="noopener noreferrer" class="nav-link external">
    29. 

  29.   Discuss
    30. 

  30.   <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Select language" class="dropdown-title"><span class="title">Languages</span> <span class="arrow down"></span></button> <button type="button" aria-label="Select language" class="mobile-dropdown-title"><span class="title">Languages</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/docs/en-US/guide/base-scroll-api.html" aria-current="page" class="nav-link router-link-exact-active router-link-active">
    31. 

  31.   English
    32. 

  32. </a></li><li class="dropdown-item"><!----> <a href="/docs/zh-CN/guide/base-scroll-api.html" class="nav-link">
    33. 

  33.   简体中文
    34. 

  34. </a></li></ul></div></div> <a href="https://github.com/ustbhuangyi/better-scroll" target="_blank" rel="noopener noreferrer" class="repo-link">
    35. 

  35.     GitHub
    36. 

  36.     <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/docs/en-US/guide/" class="nav-link router-link-active">
    37. 

  37.   Guide
    38. 

  38. </a></div><div class="nav-item"><a href="/docs/en-US/plugins/" class="nav-link">
    39. 

  39.   Plugin
    40. 

  40. </a></div><div class="nav-item"><a href="/docs/en-US/FAQ/" class="nav-link">
    41. 

  41.   FAQ
    42. 

  42. </a></div><div class="nav-item"><a href="https://github.com/ustbhuangyi/better-scroll/issues" target="_blank" rel="noopener noreferrer" class="nav-link external">
    43. 

  43.   Discuss
    44. 

  44.   <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Select language" class="dropdown-title"><span class="title">Languages</span> <span class="arrow down"></span></button> <button type="button" aria-label="Select language" class="mobile-dropdown-title"><span class="title">Languages</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/docs/en-US/guide/base-scroll-api.html" aria-current="page" class="nav-link router-link-exact-active router-link-active">
    45. 

  45.   English
    46. 

  46. </a></li><li class="dropdown-item"><!----> <a href="/docs/zh-CN/guide/base-scroll-api.html" class="nav-link">
    47. 

  47.   简体中文
    48. 

  48. </a></li></ul></div></div> <a href="https://github.com/ustbhuangyi/better-scroll" target="_blank" rel="noopener noreferrer" class="repo-link">
    49. 

  49.     GitHub
    50. 

  50.     <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav>  <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Guide</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/docs/en-US/guide/" aria-current="page" class="sidebar-link">Introduction</a></li><li><a href="/docs/en-US/guide/how-to-install.html" class="sidebar-link">Install</a></li><li><a href="/docs/en-US/guide/use.html" class="sidebar-link">How to use</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>Base Scroll</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/docs/en-US/guide/base-scroll.html" class="sidebar-link">base-scroll</a></li><li><a href="/docs/en-US/guide/base-scroll-options.html" class="sidebar-link">Options</a></li><li><a href="/docs/en-US/guide/base-scroll-api.html" aria-current="page" class="active sidebar-link">API</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/en-US/guide/base-scroll-api.html#properties" class="sidebar-link">Properties</a></li><li class="sidebar-sub-header"><a href="/docs/en-US/guide/base-scroll-api.html#methods" class="sidebar-link">Methods</a></li><li class="sidebar-sub-header"><a href="/docs/en-US/guide/base-scroll-api.html#events-vs-hooks" class="sidebar-link">Events VS Hooks</a></li><li class="sidebar-sub-header"><a href="/docs/en-US/guide/base-scroll-api.html#events" class="sidebar-link">Events</a></li><li class="sidebar-sub-header"><a href="/docs/en-US/guide/base-scroll-api.html#hooks" class="sidebar-link">Hooks</a></li></ul></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="api"><a href="#api" class="header-anchor">#</a> API</h1> <p>If you want to understand BetterScroll thoroughly, you need to understand the common properties of its instances, the flexible methods, and the hooks provided.</p> <h2 id="properties"><a href="#properties" class="header-anchor">#</a> Properties</h2> <p>Sometimes we want to do some extensions based on BetterScroll, we need to understand some of the properties of BetterScroll. Here are a few common properties.</p> <h3 id="x"><a href="#x" class="header-anchor">#</a> x</h3> <ul><li><strong>Type</strong>: <code>number</code>.</li> <li><strong>Usage</strong>: scroll horizontal axis coordinate.</li></ul> <h3 id="y"><a href="#y" class="header-anchor">#</a> y</h3> <ul><li><strong>Type</strong>: <code>number</code>.</li> <li><strong>Usage</strong>: scroll vertical axis coordinate.</li></ul> <h3 id="maxscrollx"><a href="#maxscrollx" class="header-anchor">#</a> maxScrollX</h3> <ul><li><strong>Type</strong>: <code>number</code></li> <li><strong>Usage</strong>: max scrollable horizontal coordinate.</li> <li><strong>Note</strong>: horizontal scroll range is [minScrollX, maxScrollX], and maxScrollX is negative value.</li></ul> <h3 id="minscrollx"><a href="#minscrollx" class="header-anchor">#</a> minScrollX</h3> <ul><li><strong>Type</strong>: <code>number</code></li> <li><strong>Usage</strong>: min scrollable horizontal coordinate.</li> <li><strong>Note</strong>: horizontal scroll range is [minScrollX, maxScrollX], and minScrollX is positive value.</li></ul> <h3 id="maxscrolly"><a href="#maxscrolly" class="header-anchor">#</a> maxScrollY</h3> <ul><li><strong>Type</strong>: <code>number</code></li> <li><strong>Usage</strong>: max scrollable vertical coordinate</li> <li><strong>Note</strong>: vertical scroll range is [minScrollY, maxScrollY], and maxScrollY is negative value.</li></ul> <h3 id="minscrolly"><a href="#minscrolly" class="header-anchor">#</a> minScrollY</h3> <ul><li><strong>Type</strong>: <code>number</code></li> <li><strong>Usage</strong>: min scrollable vertical coordinate</li> <li><strong>Note</strong>: vertical scroll range is [minScrollY, maxScrollY], and minScrollY is positive value.</li></ul> <h3 id="movingdirectionx"><a href="#movingdirectionx" class="header-anchor">#</a> movingDirectionX</h3> <ul><li><strong>Type</strong>: <code>number</code></li> <li><strong>Usage</strong>: estimate the moving direction on horizontal is left or right.</li> <li><strong>Note</strong>: -1 means finger moves from left to right, 1 means moving from right to left, 0 means haven't moved.</li></ul> <h3 id="movingdirectiony"><a href="#movingdirectiony" class="header-anchor">#</a> movingDirectionY</h3> <ul><li><strong>Type</strong>: <code>number</code></li> <li><strong>Usage</strong>: estimate the moving direction on vertical is up or down during scrolling.</li> <li><strong>Note</strong>: -1 means finger moves from up to down, 1 means from down to up, 0 means haven't moved.</li></ul> <h3 id="directionx"><a href="#directionx" class="header-anchor">#</a> directionX</h3> <ul><li><strong>Type</strong>: <code>number</code></li> <li><strong>Usage</strong>: estimate the moving direction on horizontal between start position and end position is left or right.</li> <li><strong>Note</strong>: -1 means finger moves from up to down, 1 means from down to up, 0 means haven't moved.</li></ul> <h3 id="directiony"><a href="#directiony" class="header-anchor">#</a> directionY</h3> <ul><li><strong>Type</strong>: <code>number</code></li> <li><strong>Usage</strong>: estimate the moving direction on vertical between start position and end position is up or down.</li> <li><strong>Note</strong>: -1 means finger moves from up to down, 1 means from down to up, 0 means haven't moved.</li></ul> <h3 id="enabled"><a href="#enabled" class="header-anchor">#</a> enabled</h3> <ul><li><strong>Type</strong>: <code>boolean</code>,</li> <li><strong>Usage</strong>: estimate whether the current scroll is enabled.</li></ul> <h3 id="pending"><a href="#pending" class="header-anchor">#</a> pending</h3> <ul><li><strong>Type</strong>: <code>boolean</code>,</li> <li><strong>Usage</strong>: estimate whether the current scroll is animating.</li></ul> <h2 id="methods"><a href="#methods" class="header-anchor">#</a> Methods</h2> <p>BetterScroll provides a lot of flexible APIs, which are used when we implement some features based on BetterScroll, and understanding them will help to meet more complex requirements.</p> <h3 id="refresh"><a href="#refresh" class="header-anchor">#</a> refresh()</h3> <ul><li><strong>Arguments</strong>: none.</li> <li><strong>Return</strong>: none.</li> <li><strong>Usage</strong>: recalculate BetterScroll to ensure scroll work properly when the structure of DOM changes.</li></ul> <h3 id="scrollto-x-y-time-easing-extratransform"><a href="#scrollto-x-y-time-easing-extratransform" class="header-anchor">#</a> scrollTo(x, y, time, easing, extraTransform)</h3> <ul><li><strong>Arguments</strong>:
    51. 

  51. <ul><li><code>{number} x</code>, horizontal axis distance. (unit: px)</li> <li><code>{number} y</code>, vertical axis distance. (unit: px)</li> <li><code>{number} time</code>, animation duration. (unit: ms)</li> <li><code>{Object} easing function</code>, usually don't suggest modifying. If you really need to modify, please refer <code>packages/shared-utils/src/ease.ts</code>'s of source code</li> <li><code>{Object} extraTransform</code>, you only need to pass in this parameter if you want to modify some other properties of the CSS transform. The structure is as follows:</li></ul> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">let</span> extraTransform <span class="token operator">=</span> <span class="token punctuation">{</span>
    52. 

  52.   <span class="token comment">// start point</span>
    53. 

  53.   <span class="token literal-property property">start</span><span class="token operator">:</span> <span class="token punctuation">{</span>
    54. 

  54.     <span class="token literal-property property">scale</span><span class="token operator">:</span> <span class="token number">0</span>
    55. 

  55.   <span class="token punctuation">}</span><span class="token punctuation">,</span>
    56. 

  56.   <span class="token comment">// end poinnt</span>
    57. 

  57.   <span class="token literal-property property">end</span><span class="token operator">:</span> <span class="token punctuation">{</span>
    58. 

  58.     <span class="token literal-property property">scale</span><span class="token operator">:</span> <span class="token number">1.1</span>
    59. 

  59.   <span class="token punctuation">}</span>
    60. 

  60. <span class="token punctuation">}</span>
    61. 

  61. bs<span class="token punctuation">.</span><span class="token function">scrollTo</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token operator">-</span><span class="token number">60</span><span class="token punctuation">,</span> <span class="token number">300</span><span class="token punctuation">,</span> <span class="token keyword">undefined</span><span class="token punctuation">,</span> extraTransform<span class="token punctuation">)</span>
    62. 

  62. </code></pre></div></li> <li><strong>Return</strong>: none.</li> <li><strong>Usage</strong>: scroll to specified position.</li></ul> <h3 id="scrollby-x-y-time-easing"><a href="#scrollby-x-y-time-easing" class="header-anchor">#</a> scrollBy(x, y, time, easing)</h3> <ul><li><strong>Arguments</strong>:
    63. 

  63. <ul><li><code>{number} x</code>, horizontal axis changed distance. (unit: px)</li> <li><code>{number} y</code>, vertical axis changed distance. (unit: px)</li> <li><code>{number} time</code>, animation duration. (unit: ms)</li> <li><code>{Object} easing function</code>, usually don't suggest modifying. If you really need to modify, please refer <code>packages/shared-utils/src/ease.ts</code>.</li></ul></li> <li><strong>Return</strong>: none.</li> <li><strong>Usage</strong>: scroll to specified position based on current position.</li></ul> <h3 id="scrolltoelement-el-time-offsetx-offsety-easing"><a href="#scrolltoelement-el-time-offsetx-offsety-easing" class="header-anchor">#</a> scrollToElement(el, time, offsetX, offsetY, easing)</h3> <ul><li><strong>Arguments</strong>:
    64. 

  64. <ul><li><code>{DOM | string} el</code>, target element. If the value is a string, we will try to use querySelector get the DOM element.</li> <li><code>{number} time</code>, animation duration. (unit ms)</li> <li><code>{number | boolean}</code> offsetX, the x offset to target element，If the value is true, scroll to the center of target element.</li> <li><code>{number | boolean}</code> offsetY, the y offset to target element，If the value is true, scroll to the center of target element.</li> <li><code>{Object} easing function</code>, usually don't suggest modifying. If you really need to modify, please refer <code>packages/shared-utils/src/ease.ts</code>.</li></ul></li> <li><strong>Return</strong>: none.</li> <li><strong>Usage</strong>: scroll to target element.</li></ul> <h3 id="stop"><a href="#stop" class="header-anchor">#</a> stop()</h3> <ul><li><strong>Arguments</strong>: none.</li> <li><strong>Return</strong>: none.</li> <li><strong>Usage</strong>: stop the scroll animation immediately.</li></ul> <h3 id="enable"><a href="#enable" class="header-anchor">#</a> enable()</h3> <ul><li><strong>Arguments</strong>: none.</li> <li><strong>Return</strong>: none.</li> <li><strong>Usage</strong>: enable BetterScroll. It's enabled by default.</li></ul> <h3 id="disable"><a href="#disable" class="header-anchor">#</a> disable()</h3> <ul><li><strong>Arguments</strong>: none.</li> <li><strong>Return</strong>: none.</li> <li><strong>Usage</strong>: disable BetterScroll. And it will make the callbacks of DOM events don't response.</li></ul> <h3 id="destroy"><a href="#destroy" class="header-anchor">#</a> destroy()</h3> <ul><li><strong>Arguments</strong>: none.</li> <li><strong>Return</strong>: none.</li> <li><strong>Usage</strong>: destroy BetterScroll，remove events and free some memory when the scroll is not needed anymore.</li></ul> <h3 id="on-type-fn-context"><a href="#on-type-fn-context" class="header-anchor">#</a> on(type, fn, context)</h3> <ul><li><strong>Arguments</strong>:
    65. 

  65. <ul><li><code>{string} type</code>, event</li> <li><code>{Function} fn</code>, callback</li> <li><code>{Object} context</code>,default is <code>this</code>.</li></ul></li> <li><strong>Return</strong>: none</li> <li><strong>Usage</strong>: listen for a hook on the current BScroll, such as &quot;scroll&quot;, &quot;scrollEnd&quot; and so on.</li> <li><strong>Example</strong>:</li></ul> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@BetterScroll/core'</span>
    66. 

  66. <span class="token keyword">let</span> scroll <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
    67. 

  67.   <span class="token literal-property property">probeType</span><span class="token operator">:</span> <span class="token number">3</span>
    68. 

  68. <span class="token punctuation">}</span><span class="token punctuation">)</span>
    69. 

  69. <span class="token keyword">function</span> <span class="token function">onScroll</span><span class="token punctuation">(</span><span class="token parameter">pos</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
    70. 

  70.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">Now position is x: </span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>pos<span class="token punctuation">.</span>x<span class="token interpolation-punctuation punctuation">}</span></span><span class="token string">, y: </span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>pos<span class="token punctuation">.</span>y<span class="token interpolation-punctuation punctuation">}</span></span><span class="token template-punctuation string">`</span></span><span class="token punctuation">)</span>
    71. 

  71. <span class="token punctuation">}</span>
    72. 

  72. scroll<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scroll'</span><span class="token punctuation">,</span> onScroll<span class="token punctuation">)</span>
    73. 

  73. </code></pre></div><h3 id="once-type-fn-context"><a href="#once-type-fn-context" class="header-anchor">#</a> once(type, fn, context)</h3> <ul><li><strong>Arguments</strong>:
    74. 

  74. <ul><li><code>{string} type</code>, event</li> <li><code>{Function} fn</code>, callback</li> <li><code>{Object} context</code>, default is <code>this</code>.</li></ul></li> <li><strong>Return</strong>: none</li> <li><strong>Usage</strong>: listen for a custom event, but only once. The listener will be removed once it triggers for the first time.</li></ul> <h3 id="off-type-fn"><a href="#off-type-fn" class="header-anchor">#</a> off(type, fn)</h3> <ul><li><strong>Arguments</strong>:
    75. 

  75. <ul><li><code>{string} type</code>, event</li> <li><code>{Function} fn</code>, callback</li></ul></li> <li><strong>Return</strong>: none</li> <li><strong>Usage</strong>: remove custom event listener. Only remove the listener for that specific callback.</li> <li><strong>Example</strong>:</li></ul> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@BetterScroll/core'</span>
    76. 

  76. <span class="token keyword">let</span> scroll <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
    77. 

  77.   <span class="token literal-property property">probeType</span><span class="token operator">:</span> <span class="token number">3</span>
    78. 

  78. <span class="token punctuation">}</span><span class="token punctuation">)</span>
    79. 

  79. <span class="token keyword">function</span> <span class="token function">handler</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
    80. 

  80.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'bs is scrolling now'</span><span class="token punctuation">)</span>
    81. 

  81. <span class="token punctuation">}</span>
    82. 

  82. scroll<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scroll'</span><span class="token punctuation">,</span> handler<span class="token punctuation">)</span>
    83. 

  83. 

  84. scroll<span class="token punctuation">.</span><span class="token function">off</span><span class="token punctuation">(</span><span class="token string">'scroll'</span><span class="token punctuation">,</span> handler<span class="token punctuation">)</span>
    85. 

  85. </code></pre></div><h2 id="events-vs-hooks"><a href="#events-vs-hooks" class="header-anchor">#</a> Events VS Hooks</h2> <p>Based on the 2.x architecture design and compatibility with 1.x events, we have extended two concepts-&quot;<strong>Events</strong>&quot; and &quot;<strong>Hooks</strong>&quot;. Basically, they are all instances of <code>EventEmitter</code>, but they are called differently. Let's explain it from the excerpted source code below:</p> <div class="language-typescript extra-class"><pre class="language-typescript"><code>  <span class="token keyword">export</span> <span class="token keyword">default</span> BScrollCore <span class="token keyword">extends</span> <span class="token class-name">EventEmitter</span> <span class="token punctuation">{</span>
    86. 

  86.     hooks<span class="token operator">:</span> EventEmitter
    87. 

  87.   <span class="token punctuation">}</span>
    88. 

  88. </code></pre></div><ul><li><p><strong>BScrollCore</strong></p> <p>It inherits EventEmitter itself. we all call it &quot;<strong>event</strong>&quot;.</p> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    89. 

  89.   <span class="token keyword">let</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    90. 

  90. 

  91.   <span class="token comment">// listen bs scroll event</span>
    92. 

  92.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scroll'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    93. 

  93.   <span class="token comment">// listen bs refresh event</span>
    94. 

  94.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'refresh'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    95. 

  95. </code></pre></div></li> <li><p><strong>BScrollCore.hooks</strong></p> <p>Hooks are also instances of EventEmitter. we all call it &quot;<strong>hook</strong>&quot;.</p> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    96. 

  96.   <span class="token keyword">let</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    97. 

  97. 

  98.   <span class="token comment">// tap bs refresh hook</span>
    99. 

  99.   bs<span class="token punctuation">.</span>hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'refresh'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    100. 

  100.   <span class="token comment">// tap bs enable hook</span>
    101. 

  101.   bs<span class="token punctuation">.</span>hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'enable'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    102. 

  102. </code></pre></div></li></ul> <p>I believe everyone now has a better distinction between the two. &quot;<strong>Event</strong>&quot; is for the compatibility of 1.x. Users generally pay attention to the distribution of events, but if you want to write a plugin, you should focus on &quot;<strong>hooks</strong>&quot;.</p> <h2 id="events"><a href="#events" class="header-anchor">#</a> Events</h2> <p>In 2.0, BetterScroll events are almost same with 1.x events. Only BetterScroll will dispatch &quot;<strong>events</strong>&quot;. If you need to expose events when writing plugins, you should also dispatch them through BetterScroll. <a href="/docs/en-US/plugins/how-to-write.html">details is here</a>, the current events are divided into the following types:</p> <ul><li><p><strong>refresh</strong></p> <ul><li><strong>Trigger timing</strong>: BetterScroll recalculate</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BetterScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    103. 

  103. 

  104.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BetterScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    105. 

  105. 

  106.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'refresh'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    107. 

  107. </code></pre></div></li> <li><p><strong>enable</strong></p> <ul><li><strong>Trigger timing</strong>: BetterScroll is enabled and starts to respond to user interaction</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'enable'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    108. 

  108. </code></pre></div></li> <li><p><strong>disable</strong></p> <ul><li><strong>Trigger timing</strong>: BetterScroll is disabled and no longer responds to user interaction</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'disable'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    109. 

  109. </code></pre></div></li> <li><p><strong>beforeScrollStart</strong></p> <ul><li><strong>Trigger timing</strong>: When the user's finger is placed on the scroll area</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeScrollStart'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    110. 

  110. </code></pre></div></li> <li><p><strong>scrollStart</strong></p> <ul><li><strong>Trigger timing</strong>: Content element meets the scrolling conditions and will start scrolling</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scrollStart'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    111. 

  111. </code></pre></div></li> <li><p><strong>scroll</strong></p> <ul><li><strong>Trigger timing</strong>: It is scrolling</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scroll'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">position</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    112. 

  112.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>position<span class="token punctuation">.</span>x<span class="token punctuation">,</span> position<span class="token punctuation">.</span>y<span class="token punctuation">)</span>
    113. 

  113.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    114. 

  114. </code></pre></div></li> <li><p><strong>scrollEnd</strong></p> <ul><li><strong>Trigger timing</strong>: End of scrolling, or force a content that is scrolling to stop</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scrollEnd'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    115. 

  115. </code></pre></div></li> <li><p><strong>scrollCancel</strong></p> <ul><li><strong>Trigger timing</strong>: Scroll cancel</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scrollCancel'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    116. 

  116. </code></pre></div></li> <li><p><strong>touchEnd</strong></p> <ul><li><strong>Trigger timing</strong>: User finger leaves the scroll area</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'touchEnd'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    117. 

  117. </code></pre></div></li> <li><p><strong>flick</strong></p> <ul><li><strong>Trigger timing</strong>: User triggered flick operation</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'flick'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    118. 

  118. </code></pre></div></li> <li><p><strong>destroy</strong></p> <ul><li><strong>Trigger timing</strong>: BetterScroll destroyed</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'destroy'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    119. 

  119. </code></pre></div></li> <li><p><strong>contentChanged</strong> <span class="badge tip" style="vertical-align:top;" data-v-15b7b770>2.0.4</span></p> <ul><li><strong>Trigger timing</strong>: When calling <code>bs.refresh()</code>, it is detected that the content DOM has become other elements</li></ul> <div class="language-typescript extra-class"><pre class="language-typescript"><code>  <span class="token comment">// bs version &gt;= 2.0.4</span>
    120. 

  120.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'contentChanged'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span>newContent<span class="token operator">:</span> HTMLElement<span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    121. 

  121. </code></pre></div></li></ul> <p>The following events must be registered for the <strong>plugin</strong> in parentheses to be dispatched:</p> <ul><li><p><strong>alterOptions(<strong>mouse-wheel</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: mouse-wheel scroll starts</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BetterScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    122. 

  122.   <span class="token keyword">import</span> MouseWheel <span class="token keyword">from</span> <span class="token string">'@better-scroll/mouse-wheel'</span>
    123. 

  123. 

  124.   BetterScroll<span class="token punctuation">.</span><span class="token function">use</span><span class="token punctuation">(</span>MouseWheel<span class="token punctuation">)</span>
    125. 

  125.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BetterScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
    126. 

  126.     <span class="token literal-property property">mouseWheel</span><span class="token operator">:</span> <span class="token boolean">true</span>
    127. 

  127.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    128. 

  128. 

  129.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'alterOptions'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">mouseWheelOptions</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    130. 

  130.     <span class="token comment">/**
    131. 

  131.      * mouseWheelOptions.speed
    132. 

  132.      * mouseWheelOptions.invert
    133. 

  133.      * mouseWheelOptions.easeTime
    134. 

  134.      * mouseWheelOptions.discreteTime
    135. 

  135.      * mouseWheelOptions.throttleTime
    136. 

  136.      * mouseWheelOptions.dampingFactor
    137. 

  137.      **/</span>
    138. 

  138. 

  139.     <span class="token comment">// please see details in mouse-wheel plugin doc</span>
    140. 

  140.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    141. 

  141. </code></pre></div></li> <li><p><strong>mousewheelStart(<strong>mouse-wheel</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: mouse-wheel scroll starts</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BetterScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    142. 

  142.   <span class="token keyword">import</span> MouseWheel <span class="token keyword">from</span> <span class="token string">'@better-scroll/mouse-wheel'</span>
    143. 

  143. 

  144.   BetterScroll<span class="token punctuation">.</span><span class="token function">use</span><span class="token punctuation">(</span>MouseWheel<span class="token punctuation">)</span>
    145. 

  145.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BetterScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
    146. 

  146.     <span class="token literal-property property">mouseWheel</span><span class="token operator">:</span> <span class="token boolean">true</span>
    147. 

  147.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    148. 

  148. 

  149.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'mousewheelStart'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    150. 

  150. </code></pre></div></li> <li><p><strong>mousewheelMove(<strong>mouse-wheel</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: mouse-wheel is scrolling</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'mousewheelMove'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    151. 

  151. </code></pre></div></li> <li><p><strong>mousewheelEnd(<strong>mouse-wheel</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: mouse-wheel scrollEnd</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'mousewheelEnd'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    152. 

  152. </code></pre></div></li> <li><p><strong>pullingDown(<strong>pull-down</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: When the top pull-down distance exceeds the threshold</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BetterScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    153. 

  153.   <span class="token keyword">import</span> PullDown <span class="token keyword">from</span> <span class="token string">'@better-scroll/pull-down'</span>
    154. 

  154. 

  155.   BetterScroll<span class="token punctuation">.</span><span class="token function">use</span><span class="token punctuation">(</span>PullDown<span class="token punctuation">)</span>
    156. 

  156.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BetterScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
    157. 

  157.     <span class="token literal-property property">pullDownRefresh</span><span class="token operator">:</span> <span class="token boolean">true</span>
    158. 

  158.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    159. 

  159. 

  160.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'pullingDown'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    161. 

  161.     <span class="token keyword">await</span> <span class="token function">fetchData</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    162. 

  162.     bs<span class="token punctuation">.</span><span class="token function">finishPullDown</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    163. 

  163.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    164. 

  164. </code></pre></div></li> <li><p><strong>pullingUp(<strong>pull-up</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: When the bottom pull-up distance exceeds the threshold</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BetterScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    165. 

  165.   <span class="token keyword">import</span> PullUp <span class="token keyword">from</span> <span class="token string">'@better-scroll/pull-up'</span>
    166. 

  166. 

  167.   BetterScroll<span class="token punctuation">.</span><span class="token function">use</span><span class="token punctuation">(</span>PullUp<span class="token punctuation">)</span>
    168. 

  168.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BetterScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
    169. 

  169.     <span class="token literal-property property">pullUpLoad</span><span class="token operator">:</span> <span class="token boolean">true</span>
    170. 

  170.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    171. 

  171. 

  172.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'pullingUp'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    173. 

  173.     <span class="token keyword">await</span> <span class="token function">fetchData</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    174. 

  174.     bs<span class="token punctuation">.</span><span class="token function">finishPullUp</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    175. 

  175.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    176. 

  176. </code></pre></div></li> <li><p><strong>slideWillChange(<strong>slide</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: The slide is about to switch page</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BetterScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    177. 

  177.   <span class="token keyword">import</span> Slide <span class="token keyword">from</span> <span class="token string">'@better-scroll/slide'</span>
    178. 

  178. 

  179.   BetterScroll<span class="token punctuation">.</span><span class="token function">use</span><span class="token punctuation">(</span>Slide<span class="token punctuation">)</span>
    180. 

  180. 

  181.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BetterScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
    182. 

  182.     <span class="token literal-property property">slide</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span>
    183. 

  183.     <span class="token literal-property property">momentum</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span>
    184. 

  184.     <span class="token literal-property property">bounce</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span>
    185. 

  185.     <span class="token literal-property property">probeType</span><span class="token operator">:</span> <span class="token number">2</span>
    186. 

  186.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    187. 

  187. 

  188.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'slideWillChange'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">page</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    189. 

  189.     <span class="token comment">// Page about to switch</span>
    190. 

  190.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>page<span class="token punctuation">.</span>pageX<span class="token punctuation">,</span> page<span class="token punctuation">.</span>pageY<span class="token punctuation">)</span>
    191. 

  191.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    192. 

  192. </code></pre></div></li> <li><p><strong>beforeZoomStart(<strong>zoom</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: When two fingers touch the zoom element</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BetterScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    193. 

  193.   <span class="token keyword">import</span> Zoom <span class="token keyword">from</span> <span class="token string">'@better-scroll/zoom'</span>
    194. 

  194. 

  195.   BetterScroll<span class="token punctuation">.</span><span class="token function">use</span><span class="token punctuation">(</span>Zoom<span class="token punctuation">)</span>
    196. 

  196. 

  197.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BetterScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
    198. 

  198.     <span class="token literal-property property">zoom</span><span class="token operator">:</span> <span class="token boolean">true</span>
    199. 

  199.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    200. 

  200. 

  201.   bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeZoomStart'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    202. 

  202. </code></pre></div></li> <li><p><strong>zoomStart(<strong>zoom</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: Two-finger zoom distance exceeds the minimum threshold</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'zoomStart'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    203. 

  203. </code></pre></div></li> <li><p><strong>zooming(<strong>zoom</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: While the two-finger zoom behavior is in progress</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'zooming'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter"><span class="token punctuation">{</span> scale <span class="token punctuation">}</span></span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    204. 

  204.     <span class="token comment">// current scale</span>
    205. 

  205.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    206. 

  206. </code></pre></div></li> <li><p><strong>zoomEnd(<strong>zoom</strong>)</strong></p> <ul><li><strong>Trigger timing</strong>: After the two-finger zoom action ends</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  bs<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'zoomEnd'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter"><span class="token punctuation">{</span> scale <span class="token punctuation">}</span></span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    207. 

  207. </code></pre></div></li></ul> <h2 id="hooks"><a href="#hooks" class="header-anchor">#</a> Hooks</h2> <p>A hook is a concept extended from version 2.0. Its essence is the same as an event. It is an instance of EventEmitter, which is a typical subscription publishing model. As the smallest scroll unit, BScrollCore also has many functional classes inside. Each functional class has a property called hooks, which bridges the communication between different classes. If you want to write a complex plugin, hooks must be mastered.</p> <ul><li><p><strong>BScrollCore.hooks</strong></p> <ul><li><p><strong>beforeInitialScrollTo</strong></p> <ul><li><strong>Trigger timing</strong>: After initial loading the plugin, you need to scroll to the specified position</li> <li><strong>Arguments</strong>: position object
    208. 

  208. <ul><li><code>{ x: number, y: number }</code></li></ul></li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    209. 

  209.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    210. 

  210.   bs<span class="token punctuation">.</span>hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeInitialScrollTo'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">postion</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    211. 

  211.     postion<span class="token punctuation">.</span>x <span class="token operator">=</span> <span class="token number">0</span>
    212. 

  212.     position<span class="token punctuation">.</span>y <span class="token operator">=</span> <span class="token operator">-</span><span class="token number">200</span> <span class="token comment">// Initialize scroll to -200</span>
    213. 

  213.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    214. 

  214. </code></pre></div></li> <li><p><strong>refresh</strong></p> <ul><li><strong>Trigger timing</strong>: Recalculate BetterScroll</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    215. 

  215.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    216. 

  216.   bs<span class="token punctuation">.</span>hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'refresh'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'refreshed'</span><span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    217. 

  217. </code></pre></div></li> <li><p><strong>enable</strong></p> <ul><li><strong>Trigger timing</strong>: Enable BetterScroll to respond to user behavior</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    218. 

  218.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    219. 

  219.   bs<span class="token punctuation">.</span>hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'enable'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'enabled'</span><span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    220. 

  220. </code></pre></div></li> <li><p><strong>disable</strong></p> <ul><li><strong>Trigger timing</strong>: Disable BetterScroll and no longer respond to user behavior</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    221. 

  221.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    222. 

  222.   bs<span class="token punctuation">.</span>hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'disable'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'disabled'</span><span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    223. 

  223. </code></pre></div></li> <li><p><strong>destroy</strong></p> <ul><li><strong>Trigger timing</strong>: Destroy BetterScroll</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    224. 

  224.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    225. 

  225.   bs<span class="token punctuation">.</span>hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'destroy'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'destroyed'</span><span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    226. 

  226. </code></pre></div></li> <li><p><strong>contentChanged</strong> <span class="badge tip" style="vertical-align:top;" data-v-15b7b770>2.0.4</span></p> <ul><li><strong>Trigger timing</strong>：When calling <code>bs.refresh()</code>, it is detected that the content DOM has become other elements</li> <li><strong>Usage</strong></li></ul> <div class="language-typescript extra-class"><pre class="language-typescript"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    227. 

  227.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    228. 

  228.   <span class="token comment">// bs version &gt;= 2.0.4</span>
    229. 

  229.   bs<span class="token punctuation">.</span>hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'contentChanged'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span>newContent<span class="token operator">:</span> HTMLElement<span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> <span class="token builtin">console</span><span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>newContent<span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    230. 

  230. </code></pre></div></li></ul></li> <li><p><strong>ActionsHandler.hooks</strong></p> <ul><li><p><strong>beforeStart</strong></p> <ul><li><strong>Trigger timing</strong>: Just respond to the touchstart event, but the position of the finger on the screen has not been recorded</li> <li><strong>Arguments</strong>: event object</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    231. 

  231.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    232. 

  232.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actionsHandler<span class="token punctuation">.</span>hooks
    233. 

  233.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeStart'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">event</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>event<span class="token punctuation">.</span>target<span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    234. 

  234. </code></pre></div></li> <li><p><strong>start</strong></p> <ul><li><strong>Trigger timing</strong>: After recording the position of the finger on the screen, touchmove will be triggered</li> <li><strong>Arguments</strong>: event object</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    235. 

  235.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    236. 

  236.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actionsHandler<span class="token punctuation">.</span>hooks
    237. 

  237.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'start'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">event</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>event<span class="token punctuation">.</span>target<span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    238. 

  238. </code></pre></div></li> <li><p><strong>move</strong></p> <ul><li><strong>Trigger timing</strong>: Responding to the touchmove event, after recording the position of the finger on the screen</li> <li><strong>Arguments</strong>: Objects with the following properties
    239. 

  239. <ul><li><code>{ number } deltaX</code>: x offset</li> <li><code>{ number } deltaY</code>: y offset</li> <li><code>{ event } e</code>: event object</li></ul></li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    240. 

  240.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    241. 

  241.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actionsHandler<span class="token punctuation">.</span>hooks
    242. 

  242.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'move'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter"><span class="token punctuation">{</span> deltaX<span class="token punctuation">,</span> deltaY<span class="token punctuation">,</span> e <span class="token punctuation">}</span></span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    243. 

  243. </code></pre></div></li> <li><p><strong>end</strong></p> <ul><li><strong>Trigger timing</strong>: Responding to touchend event</li> <li><strong>Arguments</strong>: event object</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    244. 

  244.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    245. 

  245.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actionsHandler<span class="token punctuation">.</span>hooks
    246. 

  246.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'end'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">event</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    247. 

  247. </code></pre></div></li> <li><p><strong>click</strong></p> <ul><li><strong>Trigger timing</strong>: Trigger the click event</li> <li><strong>Arguments</strong>: event object</li></ul></li></ul></li> <li><p><strong>ScrollerActions.hooks</strong></p> <ul><li><p><strong>start</strong></p> <ul><li><strong>Trigger timing</strong>: After recording all the scrolling initial information</li> <li><strong>Arguments</strong>: event object</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    248. 

  248.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    249. 

  249.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actions<span class="token punctuation">.</span>hooks
    250. 

  250.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'start'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">event</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>event<span class="token punctuation">.</span>target<span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    251. 

  251. </code></pre></div></li> <li><p><strong>beforeMove</strong></p> <ul><li><strong>Trigger timing</strong>: Before checking whether it is legal scrolling</li> <li><strong>Arguments</strong>: event object</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    252. 

  252.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    253. 

  253.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actions<span class="token punctuation">.</span>hooks
    254. 

  254.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeMove'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">event</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>event<span class="token punctuation">.</span>target<span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    255. 

  255. </code></pre></div></li> <li><p><strong>scrollStart</strong></p> <ul><li><strong>Trigger timing</strong>: scroll is abount to start</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    256. 

  256.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    257. 

  257.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actions<span class="token punctuation">.</span>hooks
    258. 

  258.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scrollStart'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    259. 

  259. </code></pre></div></li> <li><p><strong>scroll</strong></p> <ul><li><strong>Trigger timing</strong>: It is scrolling</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    260. 

  260.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    261. 

  261.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actions<span class="token punctuation">.</span>hooks
    262. 

  262.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scroll'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    263. 

  263. </code></pre></div></li> <li><p><strong>beforeEnd</strong></p> <ul><li><strong>Trigger timing</strong>: The touchend event callback has just been executed, but the final position has not been updated</li> <li><strong>Arguments</strong>: event object</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    264. 

  264.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    265. 

  265.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actions<span class="token punctuation">.</span>hooks
    266. 

  266.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeEnd'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">event</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>event<span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    267. 

  267. </code></pre></div></li> <li><p><strong>end</strong></p> <ul><li><strong>Trigger timing</strong>: Just execute the touchend event callback and update the scroll direction</li> <li><strong>Arguments</strong>: Two Arguments, the first is the event object, the second is the current position
    268. 

  268. <ul><li><code>{ event } e</code>: event object</li> <li><code>{ x: number, y: number } postion</code>: current position</li></ul></li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    269. 

  269.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    270. 

  270.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actions<span class="token punctuation">.</span>hooks
    271. 

  271.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'end'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">e<span class="token punctuation">,</span> postion</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>e<span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    272. 

  272. </code></pre></div></li> <li><p><strong>scrollEnd</strong></p> <ul><li><strong>Trigger timing</strong>: Scrolling is about to end, but you still need to verify whether a scrolling behavior triggers flick and momentum behaviors.</li> <li><strong>Arguments</strong>: Two Arguments, the first is the current position, the second is the animation duration
    273. 

  273. <ul><li><code>{ x: number, y: number } postion</code>: current position</li> <li><code>{ number } duration</code>: animation duration</li></ul></li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    274. 

  274.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    275. 

  275.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actions<span class="token punctuation">.</span>hooks
    276. 

  276.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeEnd'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">pos<span class="token punctuation">,</span> duration</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>pos<span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">)</span>
    277. 

  277. </code></pre></div></li> <li><p><strong>coordinateTransformation</strong></p> <ul><li><strong>Trigger timing</strong>: After calculating the offset of the user's finger, before scrolling occurs</li> <li><strong>Arguments</strong>: transformateDeltaData object
    278. 

  278. <ul><li><code>{ deltaX: number, deltaY: number } transformateDeltaData</code></li></ul></li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">let</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
    279. 

  279.     <span class="token literal-property property">quadrant</span><span class="token operator">:</span> <span class="token number">1</span> <span class="token comment">// default value</span>
    280. 

  280. <span class="token punctuation">}</span><span class="token punctuation">)</span>
    281. 

  281. bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>actions<span class="token punctuation">.</span>hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span>
    282. 

  282.   <span class="token string">'coordinateTransformation'</span><span class="token punctuation">,</span>
    283. 

  283.   <span class="token punctuation">(</span><span class="token parameter">transformateDeltaData</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    284. 

  284.     <span class="token comment">// get user finger moved distance</span>
    285. 

  285.     <span class="token keyword">const</span> originDeltaX <span class="token operator">=</span> transformateDeltaData<span class="token punctuation">.</span>deltaX
    286. 

  286.     <span class="token keyword">const</span> originDeltaY <span class="token operator">=</span> transformateDeltaData<span class="token punctuation">.</span>deltaY
    287. 

  287. 

  288.     <span class="token comment">// apply transformation</span>
    289. 

  289.     transformateDeltaData<span class="token punctuation">.</span>deltaX <span class="token operator">=</span> originDeltaY
    290. 

  290.     transformateDeltaData<span class="token punctuation">.</span>deltaY <span class="token operator">=</span> originDeltaX
    291. 

  291. 

  292.     <span class="token comment">// transformateDeltaData.deltaX will be used as content DOM style's translateX</span>
    293. 

  293.     <span class="token comment">// transformateDeltaData.deltaY will be used as content DOM style's translateY</span>
    294. 

  294.   <span class="token punctuation">}</span>
    295. 

  295. <span class="token punctuation">)</span>
    296. 

  296. </code></pre></div><p>This hook is usually to fix the logic of user-defined displacement transformation when the ancestor element of the wrapper DOM of BetterScroll is rotated. In most cases, it only needs to be configured <a href="/docs/en-US/guide/base-scroll-options.html#quadrant">quadrant</a>.</p></li></ul></li> <li><p><strong>Behavior.hooks</strong></p> <ul><li><p><strong>beforeComputeBoundary</strong></p> <ul><li><strong>Trigger timing</strong>: About to calculate the scroll boundary</li> <li><strong>Arguments</strong>: boundary object
    297. 

  297. <ul><li><code>{ minScrollPos: number, maxScrollPos: number } boundary</code></li></ul></li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    298. 

  298.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    299. 

  299.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>scrollBehaviorX<span class="token punctuation">.</span>hooks
    300. 

  300.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeComputeBoundary'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    301. 

  301. </code></pre></div></li> <li><p><strong>computeBoundary</strong></p> <ul><li><strong>Trigger timing</strong>: Calculate the scroll boundary</li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    302. 

  302.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    303. 

  303.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>scrollBehaviorX<span class="token punctuation">.</span>hooks
    304. 

  304.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'computeBoundary'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">boundary</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    305. 

  305.     <span class="token comment">// The maximum value of the upper boundary, the more positive, the greater the pull down</span>
    306. 

  306.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>boundary<span class="token punctuation">.</span>minScrollPos<span class="token punctuation">)</span>
    307. 

  307.     <span class="token comment">// The minimum value of the lower boundary, the more negative, the farther you roll</span>
    308. 

  308.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>boundary<span class="token punctuation">.</span>maxScrollPos<span class="token punctuation">)</span>
    309. 

  309.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    310. 

  310. </code></pre></div></li> <li><p><strong>momentum</strong></p> <ul><li><strong>Trigger timing</strong>: Meet the conditions for triggering momentum animation, and before calculating distance</li> <li><strong>Arguments</strong>: Two Arguments, the first is the momentumData object, the second is the scroll offset
    311. 

  311. <ul><li><code>{ destination: number, duration: number, rate: number} momentumData</code>: destination is the target position, duration is the easing time, rate is the slope</li> <li><code>{ number } distance</code>: Scroll offset to trigger momentum</li></ul></li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    312. 

  312.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    313. 

  313.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>scrollBehaviorX<span class="token punctuation">.</span>hooks
    314. 

  314.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'momentum'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">momentumData<span class="token punctuation">,</span> distance</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    315. 

  315. </code></pre></div></li> <li><p><strong>end</strong></p> <ul><li><strong>Trigger timing</strong>: Does not meet the conditions for triggering momentum animation</li> <li><strong>Arguments</strong>: momentumInfo object
    316. 

  316. <ul><li><code>{ destination: number, duration: number} momentumInfo</code>: destination is the target position, duration is the easing time</li></ul></li> <li><strong>Usage</strong></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    317. 

  317.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    318. 

  318.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>scrollBehaviorX<span class="token punctuation">.</span>hooks
    319. 

  319.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'end'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">momentumInfo</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    320. 

  320.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>momentumInfo<span class="token punctuation">.</span>destination<span class="token punctuation">)</span>
    321. 

  321.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>momentumInfo<span class="token punctuation">.</span>duration<span class="token punctuation">)</span>
    322. 

  322.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    323. 

  323. </code></pre></div></li></ul></li> <li><p><strong>Animation.hooks(useTransition: false)</strong></p> <ul><li><p><strong>forceStop</strong></p> <ul><li><strong>Trigger timing</strong>: Force a scrolling bs to stop</li> <li><strong>Arguments</strong>: position object
    324. 

  324. <ul><li><code>{ x: number, y: number } position</code></li></ul></li></ul></li> <li><p><strong>move</strong></p> <ul><li><strong>Trigger timing</strong>: Scrolling</li> <li><strong>Arguments</strong>: position object
    325. 

  325. <ul><li><code>{ x: number, y: number } position</code></li></ul></li></ul></li> <li><p><strong>end</strong></p> <ul><li><strong>Trigger timing</strong>: Scroll ended</li> <li><strong>Arguments</strong>: position object
    326. 

  326. <ul><li><code>{ x: number, y: number } position</code></li></ul></li></ul></li></ul></li> <li><p><strong>Transition.hooks(useTransition: true)</strong></p> <ul><li><p><strong>forceStop</strong></p> <ul><li><strong>Trigger timing</strong>: Force a bs that is doing animation to stop</li> <li><strong>Arguments</strong>: position object
    327. 

  327. <ul><li><code>{ x: number, y: number } position</code></li></ul></li></ul></li> <li><p><strong>move</strong></p> <ul><li><strong>Trigger timing</strong>: Scrolling</li> <li><strong>Arguments</strong>: position object
    328. 

  328. <ul><li><code>{ x: number, y: number } position</code></li></ul></li></ul></li> <li><p><strong>end</strong></p> <ul><li><strong>Trigger timing</strong>: Scroll ended</li> <li><strong>Arguments</strong>:position object
    329. 

  329. <ul><li><code>{ x: number, y: number } position</code></li></ul></li></ul></li> <li><p><strong>time</strong></p> <ul><li><strong>Trigger timing</strong>: Before the CSS3 transition started, the wheel plugin listened to the hook</li> <li><strong>Arguments</strong>: CSS3 transition duration<div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    330. 

  330.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    331. 

  331.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>animater<span class="token punctuation">.</span>hooks
    332. 

  332.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'time'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">duration</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    333. 

  333.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>duration<span class="token punctuation">)</span> <span class="token comment">// 800</span>
    334. 

  334.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    335. 

  335. </code></pre></div></li></ul></li> <li><p><strong>timeFunction</strong></p> <ul><li><strong>Trigger timing</strong>:  Before the CSS3 transition started, the wheel plugin listened to the hook</li> <li><strong>Arguments</strong>: CSS3 transition-timing-function<div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    336. 

  336.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    337. 

  337.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>animater<span class="token punctuation">.</span>hooks
    338. 

  338.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'timeFunction'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">easing</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    339. 

  339.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>easing<span class="token punctuation">)</span> <span class="token comment">// cubic-bezier(0.1, 0.7, 1.0, 0.1)</span>
    340. 

  340.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    341. 

  341. </code></pre></div></li></ul></li></ul></li> <li><p><strong>Translater.hooks</strong></p> <ul><li><p><strong>beforeTranslate</strong></p> <ul><li><strong>Trigger timing</strong>: Before modifying the transform style of the content element, the zoom plugin listened to the hook</li> <li><strong>Arguments</strong>: The first is the transformStyle array, the second is the point object
    342. 

  342. <ul><li><code>{ ['translateX(0px)'|'translateY(0px)'] } transformStyle</code>: The property value corresponding to the current transform</li> <li><code>{ x: number, y: number } point</code>: x corresponds to the value of translateX, y corresponds to the value of translateY</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    343. 

  343.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    344. 

  344.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>translater<span class="token punctuation">.</span>hooks
    345. 

  345.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeTranslate'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">transformStyle<span class="token punctuation">,</span> point</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    346. 

  346.     transformStyle<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span><span class="token string">'scale(1.2)'</span><span class="token punctuation">)</span>
    347. 

  347.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>transformStyle<span class="token punctuation">)</span> <span class="token comment">// ['translateX(0px)', 'translateY(0px)', 'scale(1.2)']</span>
    348. 

  348.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>point<span class="token punctuation">)</span> <span class="token comment">// { x: 0, y: 0 }</span>
    349. 

  349.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    350. 

  350. </code></pre></div></li></ul></li> <li><p><strong>translate</strong></p> <ul><li><strong>Trigger timing</strong>: After modifying the transform style of the content element, the wheel plugin listened to the hook</li> <li><strong>Arguments</strong>: point object
    351. 

  351. <ul><li><code>{ x: number, y: number } point</code>: x corresponds to the value of translateX, y corresponds to the value of translateY</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    352. 

  352.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    353. 

  353.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>translater<span class="token punctuation">.</span>hooks
    354. 

  354.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'translate'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">point</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    355. 

  355.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>point<span class="token punctuation">)</span> <span class="token comment">// { x: 0, y: 0 }</span>
    356. 

  356.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    357. 

  357. </code></pre></div></li></ul></li></ul></li> <li><p><strong>Scroller.hooks</strong></p> <ul><li><p><strong>beforeStart</strong>
    358. 

  358. same with <code>ScrollerActions.hooks.start</code></p></li> <li><p><strong>beforeMove</strong>
    359. 

  359. same with <code>ScrollerActions.hooks.beforeMove</code></p></li> <li><p><strong>beforeScrollStart</strong>
    360. 

  360. same with <code>ScrollerActions.hooks.start</code></p></li> <li><p><strong>scrollStart</strong>
    361. 

  361. same with <code>ScrollerActions.hooks.scrollStart</code></p></li> <li><p><strong>scroll</strong></p> <ul><li><strong>Trigger timing</strong>: Scrolling</li> <li><strong>Arguments</strong>: position object
    362. 

  362. <ul><li><code>{ x: number, y: number } position</code></li></ul></li></ul></li> <li><p><strong>beforeEnd</strong>
    363. 

  363. same with <code>ScrollerActions.hooks.beforeEnd</code></p></li> <li><p><strong>touchEnd</strong></p> <ul><li><strong>Trigger timing</strong>: User finger leaves the scroll area</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    364. 

  364.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    365. 

  365.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>hooks
    366. 

  366.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'touchEnd'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    367. 

  367.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'your finger has leave'</span><span class="token punctuation">)</span>
    368. 

  368.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    369. 

  369. </code></pre></div></li> <li><p><strong>end</strong></p> <ul><li><strong>Trigger timing</strong>: After touchEnd, it is triggered before verifying click. The pull-down plugin is implemented based on this hook</li> <li><strong>Arguments</strong>: position object</li> <li><code>{ x: number, y: number } position</code></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    370. 

  370.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    371. 

  371.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>hooks
    372. 

  372.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'end'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">position</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    373. 

  373.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>position<span class="token punctuation">.</span>x<span class="token punctuation">)</span>
    374. 

  374.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>position<span class="token punctuation">.</span>y<span class="token punctuation">)</span>
    375. 

  375.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    376. 

  376. </code></pre></div></li> <li><p><strong>scrollEnd</strong></p> <ul><li><strong>Trigger timing</strong>: Scroll ended</li> <li><strong>Arguments</strong>: position object
    377. 

  377. <ul><li><code>{ x: number, y: number } position</code></li></ul></li></ul></li> <li><p><strong>resize</strong></p> <ul><li><strong>Trigger timing</strong>: window size changed</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    378. 

  378.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    379. 

  379.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>hooks
    380. 

  380.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'resize'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    381. 

  381.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">&quot;window's size has changed&quot;</span><span class="token punctuation">)</span>
    382. 

  382.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    383. 

  383. </code></pre></div></li> <li><p><strong>flick</strong></p> <ul><li><strong>Trigger timing</strong>: Finger flicking detected</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    384. 

  384.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    385. 

  385.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>hooks
    386. 

  386.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'flick'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    387. 

  387. </code></pre></div></li> <li><p><strong>scrollCancel</strong></p> <ul><li><strong>Trigger timing</strong>: Scroll canceled or did not happen</li></ul></li> <li><p><strong>momentum</strong></p> <ul><li><strong>Trigger timing</strong>: Momentum displacement is about to begin, and the slide plugin listens to the hook</li> <li><strong>Arguments</strong>: scrollMetaData object
    388. 

  388. <ul><li><code>{ time: number, easing: EaseItem, newX: number, newY: number }</code>: time is the duration of the animation, easing is the easing function, newX and newY are the end points</li></ul></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    389. 

  389.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    390. 

  390.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>hooks
    391. 

  391.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'momentum'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">scrollMetaData</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    392. 

  392.     scrollMetaData<span class="token punctuation">.</span>newX <span class="token operator">=</span> <span class="token number">0</span>
    393. 

  393.     scrollMetaData<span class="token punctuation">.</span>newY <span class="token operator">=</span> <span class="token operator">-</span><span class="token number">200</span>
    394. 

  394.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    395. 

  395. </code></pre></div></li> <li><p><strong>scrollTo</strong></p> <ul><li><strong>Trigger timing</strong>: Triggered when the bs.scrollTo method is called</li> <li><strong>Arguments</strong>: endPoint object
    396. 

  396. <ul><li><code>{ x: number, y: number } endPoint</code></li></ul></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    397. 

  397.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    398. 

  398.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>hooks
    399. 

  399.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scrollTo'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">endPoint</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    400. 

  400.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>endPoint<span class="token punctuation">.</span>x<span class="token punctuation">)</span>
    401. 

  401.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>endPoint<span class="token punctuation">.</span>y<span class="token punctuation">)</span>
    402. 

  402.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    403. 

  403.   bs<span class="token punctuation">.</span><span class="token function">scrollTo</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token operator">-</span><span class="token number">200</span><span class="token punctuation">)</span>
    404. 

  404. </code></pre></div></li> <li><p><strong>scrollToElement</strong></p> <ul><li><strong>Trigger timing</strong>: Triggered when the bs.scrollToElement method is called, and the wheel plugin listens to the hook</li> <li><strong>Arguments</strong>: The first is the target DOM object, the second is the coordinates of the end point
    405. 

  405. <ul><li><code>{ HTMLElment } el</code></li> <li><code>{ top: number, left: number } postion</code></li></ul></li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    406. 

  406.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    407. 

  407.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>hooks
    408. 

  408.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'scrollToElement'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">el<span class="token punctuation">,</span> pos</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
    409. 

  409.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>el<span class="token punctuation">)</span>
    410. 

  410.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>pos<span class="token punctuation">.</span>left<span class="token punctuation">)</span>
    411. 

  411.     console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>pos<span class="token punctuation">.</span>top<span class="token punctuation">)</span>
    412. 

  412.   <span class="token punctuation">}</span><span class="token punctuation">)</span>
    413. 

  413.   bs<span class="token punctuation">.</span><span class="token function">scrollToElement</span><span class="token punctuation">(</span><span class="token string">'.some-item'</span><span class="token punctuation">,</span> <span class="token number">300</span><span class="token punctuation">,</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token boolean">true</span><span class="token punctuation">)</span>
    414. 

  414. </code></pre></div></li> <li><p><strong>beforeRefresh</strong></p> <ul><li><strong>Trigger timing</strong>: Before behavior calculates the boundary, the slide plugin listens to the hook</li></ul> <div class="language-js extra-class"><pre class="language-js"><code>  <span class="token keyword">import</span> BScroll <span class="token keyword">from</span> <span class="token string">'@better-scroll/core'</span>
    415. 

  415.   <span class="token keyword">const</span> bs <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">BScroll</span><span class="token punctuation">(</span><span class="token string">'.wrapper'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    416. 

  416.   <span class="token keyword">const</span> hooks <span class="token operator">=</span> bs<span class="token punctuation">.</span>scroller<span class="token punctuation">.</span>hooks
    417. 

  417.   hooks<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'beforeRefresh'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span>
    418. 

  418. </code></pre></div></li></ul></li></ul> <div class="custom-block tip"><p class="custom-block-title">TIP</p> <p>If you are careful, you will find that some Scroller.hooks have exactly the same functions as ScrollActions.hooks. In fact, we internally use a <a href="https://github.com/ustbhuangyi/better-scroll/blob/dev/packages/core/src/utils/bubbling.ts" target="_blank" rel="noopener noreferrer">hook bubbling<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a> strategy to proxy the hooks of the inner function classes to the BetterScroll Instance in the form of bubbling to be compatible with the use of 1.x.</p></div></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/ustbhuangyi/better-scroll/edit/dev/packages/vuepress-docs/docs/en-US/guide/base-scroll-api.md" target="_blank" rel="noopener noreferrer">Edit this page on GitHub</a> <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></div> <div class="last-updated"><span class="prefix">Last Updated:</span> <span class="time">4/19/2021, 8:15:26 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
    419. 

  419.       ←
    420. 

  420.       <a href="/docs/en-US/guide/base-scroll-options.html" class="prev">
    421. 

  421.         Options
    422. 

  422.       </a></span> <!----></p></div> </main></div><div class="global-ui"><!----></div></div>
    423. 

  423.     <script src="/docs/assets/js/app.c71b64d3.js" defer></script><script src="/docs/assets/js/5.d6412664.js" defer></script><script src="/docs/assets/js/4.4855b9ef.js" defer></script><script src="/docs/assets/js/3.481632b4.js" defer></script><script src="/docs/assets/js/78.6d3ef23b.js" defer></script><script src="/docs/assets/js/7.518ccda7.js" defer></script>
    424. 

  424.   </body>
    425. 

  425. </html>
    426.