Skip to content

Commit

Permalink
Merge pull request #52 from nikrowell/readme-events
Browse files Browse the repository at this point in the history 
CodeSandbox examples for events
  • Loading branch information
David Cetinkaya authored Mar 25, 2020
2 parents 0732a5c + 864a334 commit 41a34a6
Showing 1 changed file with 30 additions and 29 deletions.
59 changes: 30 additions & 29 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,10 +145,10 @@ const embla = EmblaCarousel(emblaNode, {
</summary>
<hr>
<div>
This option aligns the slides to the start or end edge of the carousel viewport. Slides will be centered if no value is provided. Note that slide alignments will be overrided for slides at the start or end when used together with
This option aligns the slides to the start or end edge of the carousel viewport. Slides will be centered if no value is provided. Note that slide alignments will be overrided for slides at the start or end when used together with
<a href="#containscroll">
<code>containScroll</code>
</a>,
</a>,
that prevents excessive scrolling at the beginning or end.
</div>
<br>
Expand Down Expand Up @@ -541,7 +541,7 @@ const embla = EmblaCarousel(emblaNode, options)
</summary>
<hr>
<div>
This option enables adjustment of the scroll speed when triggered by any of the API methods
This option enables adjustment of the scroll speed when triggered by any of the API methods
<a href="#scrollnext">
<code>scrollNext</code>
</a>,
Expand All @@ -550,7 +550,7 @@ const embla = EmblaCarousel(emblaNode, options)
</a> and
<a href="#scrollTo">
<code>scrollTo</code>
</a>. Use a higher number for faster scrolling. Drag interactions are not affected by this because the speed in these cases is determined by how vigorous the drag gesture was.
</a>. Use a higher number for faster scrolling. Drag interactions are not affected by this because the speed in these cases is determined by how vigorous the drag gesture was.
</div>
<br>
<div>
Expand Down Expand Up @@ -1576,7 +1576,7 @@ emblaSlides.forEach((slide, index) => {
<sup>
<strong>Parameters: </strong>
<code>
options:
options:
<a href="#options">
EmblaOptions
</a>
Expand Down Expand Up @@ -1616,7 +1616,7 @@ embla.changeOptions({ loop: true })

<details>
<summary>
Destroy a carousel instance permanently.
Destroy a carousel instance permanently.
</summary>
<hr>
<div>
Expand Down Expand Up @@ -1666,10 +1666,10 @@ embla.destroy()
</summary>
<hr>
<div>
This API method enables the use of event listeners by attaching them to any of the Embla specific
This API method enables the use of event listeners by attaching them to any of the Embla specific
<a href="#events">
<code>events</code>
</a>. For example, it's useful for changing styles whenever a new target snap point has been selected or when the carousel is scrolling. Use it together with the
</a>. For example, it's useful for changing styles whenever a new target snap point has been selected or when the carousel is scrolling. Use it together with the
<a href="#off">
<code>off</code>
</a> method to remove added event listeners without destroying the carousel. However, when the
Expand Down Expand Up @@ -1730,7 +1730,7 @@ embla.on('init', onInitCallback)
This API method enables the removal of event listeners attached to Embla specific
<a href="#events">
<code>events</code>
</a>. It's useful for removing added event listeners without destroying the carousel. Note that you don't have to remove event listeners added using the
</a>. It's useful for removing added event listeners without destroying the carousel. Note that you don't have to remove event listeners added using the
<a href="#on">
<code>on</code>
</a> method when invoking
Expand Down Expand Up @@ -1808,19 +1808,19 @@ embla.on('scroll', () => {
This event fires the given callback when the carousel has initialised and its
<a href="#api">
<code>API</code>
</a> is ready to use. Note that the init event only fires once upon the first initialisation and won't trigger when invoking
</a> is ready to use. Note that the init event only fires once upon the first initialisation and won't trigger when invoking
<a href="#changeOptions">
<code>changeOptions</code>
</a> or similar.
</div>
<br>
<div>
<a href="#">
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<img src="https://rawgit.com/davidcetinkaya/embla-carousel/master/docs/assets/codesandbox-logo.svg" height="23" align="top" />
</a>
&nbsp;
<a href="#">
<code>CodeSandbox (upcoming)</code>
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<code>CodeSandbox</code>
</a>
</div>
<br>
Expand Down Expand Up @@ -1885,12 +1885,12 @@ const embla = EmblaCarousel(emblaNode, options)
</div>
<br>
<div>
<a href="#">
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<img src="https://rawgit.com/davidcetinkaya/embla-carousel/master/docs/assets/codesandbox-logo.svg" height="23" align="top" />
</a>
&nbsp;
<a href="#">
<code>CodeSandbox (upcoming)</code>
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<code>CodeSandbox</code>
</a>
</div>
<br>
Expand Down Expand Up @@ -1990,12 +1990,12 @@ embla.on('settle', () => {
</div>
<br>
<div>
<a href="#">
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<img src="https://rawgit.com/davidcetinkaya/embla-carousel/master/docs/assets/codesandbox-logo.svg" height="23" align="top" />
</a>
&nbsp;
<a href="#">
<code>CodeSandbox (upcoming)</code>
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<code>CodeSandbox</code>
</a>
</div>
<br>
Expand All @@ -2022,12 +2022,12 @@ const embla = EmblaCarousel(emblaNode, options)
</div>
<br>
<div>
<a href="#">
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<img src="https://rawgit.com/davidcetinkaya/embla-carousel/master/docs/assets/codesandbox-logo.svg" height="23" align="top" />
</a>
&nbsp;
<a href="#">
<code>CodeSandbox (upcoming)</code>
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<code>CodeSandbox</code>
</a>
</div>
<br>
Expand All @@ -2054,12 +2054,12 @@ const embla = EmblaCarousel(emblaNode, options)
</div>
<br>
<div>
<a href="#">
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<img src="https://rawgit.com/davidcetinkaya/embla-carousel/master/docs/assets/codesandbox-logo.svg" height="23" align="top" />
</a>
&nbsp;
<a href="#">
<code>CodeSandbox (upcoming)</code>
<a href="https://codesandbox.io/s/embla-carousel-events-z4ses">
<code>CodeSandbox</code>
</a>
</div>
<br>
Expand All @@ -2084,15 +2084,15 @@ const embla = EmblaCarousel(emblaNode, options)
<img src="https://rawgit.com/davidcetinkaya/embla-carousel/master/docs/assets/codesandbox-logo.svg" height="23" align="top" /> &nbsp;
<a href="https://codesandbox.io/s/embla-carousel-basic-setup-oyols">
<code>Basic Setup</code>
</a>
</a>
- With Previous, Next & Dot buttons.
</p>

<p>
<img src="https://rawgit.com/davidcetinkaya/embla-carousel/master/docs/assets/codesandbox-logo.svg" height="23" align="top" /> &nbsp;
<a href="https://codesandbox.io/s/embla-carousel-autoplay-4yhr2">
<code>Autoplay</code>
</a>
</a>
- Example of how to setup Autoplay.
</p>

Expand All @@ -2101,7 +2101,7 @@ const embla = EmblaCarousel(emblaNode, options)
## Browser Support

<p>
Embla has been tested in the browsers listed below. Special thanks goes to
Embla has been tested in the browsers listed below. Special thanks goes to
<a href="https://www.browserstack.com">BrowserStack</a>.
</p>

Expand Down Expand Up @@ -2135,7 +2135,8 @@ const embla = EmblaCarousel(emblaNode, options)
Thank you to all contributors for making Embla Carousel awesome! <a href="https://github.com/davidcetinkaya/embla-carousel/blob/master/CONTRIBUTING.md">Contributions</a> are welcome.
</p>
<p align="center">
<a href="https://github.com/michaelrambeau"><img src="https://avatars0.githubusercontent.com/u/5546996?s=122&v=4" title="michaelrambeau" width="66" height="66" style="max-width:100%;"></a>
<a href="https://github.com/nikrowell"><img src="https://avatars2.githubusercontent.com/u/260039?s=122&v=4" title="nikrowell" width="66" height="66" style="max-width:100%;"></a>
<a href="https://github.com/michaelrambeau"><img src="https://avatars0.githubusercontent.com/u/5546996?s=122&v=4" title="michaelrambeau" width="66" height="66" style="max-width:100%;"></a>
<a href="https://github.com/ehellman"><img src="https://avatars3.githubusercontent.com/u/586152?s=122&v=4" title="ehellman" width="66" height="66" style="max-width:100%;"></a>
<a href="https://github.com/afilp"><img src="https://avatars0.githubusercontent.com/u/7850073?s=122&v=4" title="afilp" width="66" height="66" style="max-width:100%;"></a>
<a href="https://github.com/mrksmts"><img src="https://avatars1.githubusercontent.com/u/437794?s=122&v=4" title="mrksmts" width="66" height="66" style="max-width:100%;"></a>
Expand Down

0 comments on commit 41a34a6

Please sign in to comment.