Skip to content

Commit 0cf986a

Browse files
committed
Implement #114.
1 parent e0b6242 commit 0cf986a

File tree

37 files changed

+1039
-177
lines changed

37 files changed

+1039
-177
lines changed

CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,10 @@ These are the actual published packages which can be installed from the npm regi
3131
| wrapper | [embla-carousel-vue](https://github.com/davidjerleke/embla-carousel/tree/master/packages/embla-carousel-vue) | <a href="https://bundlephobia.com/result?p=embla-carousel-vue@latest"><img src="https://img.shields.io/bundlephobia/minzip/embla-carousel-vue?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/embla-carousel-vue"><img src="https://img.shields.io/npm/v/embla-carousel-vue.svg?color=%23c1a8e2"></a> |
3232
| wrapper | [embla-carousel-svelte](https://github.com/davidjerleke/embla-carousel/tree/master/packages/embla-carousel-svelte) | <a href="https://bundlephobia.com/result?p=embla-carousel-svelte@latest"><img src="https://img.shields.io/bundlephobia/minzip/embla-carousel-svelte?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/embla-carousel-svelte"><img src="https://img.shields.io/npm/v/embla-carousel-svelte.svg?color=%23c1a8e2"></a> |
3333
| plugin | [embla-carousel-autoplay](https://github.com/davidjerleke/embla-carousel/tree/master/packages/embla-carousel-autoplay) | <a href="https://bundlephobia.com/result?p=embla-carousel-autoplay@latest"><img src="https://img.shields.io/bundlephobia/minzip/embla-carousel-autoplay?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/embla-carousel-autoplay"><img src="https://img.shields.io/npm/v/embla-carousel-autoplay.svg?color=%23c1a8e2"></a> |
34+
| plugin | [embla-carousel-auto-scroll](https://github.com/davidjerleke/embla-carousel/tree/master/packages/embla-carousel-auto-scroll) | <a href="https://bundlephobia.com/result?p=embla-carousel-auto-scroll@latest"><img src="https://img.shields.io/bundlephobia/minzip/embla-carousel-auto-scroll?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/embla-carousel-auto-scroll"><img src="https://img.shields.io/npm/v/embla-carousel-auto-scroll.svg?color=%23c1a8e2"></a> |
3435
| plugin | [embla-carousel-auto-height](https://github.com/davidjerleke/embla-carousel/tree/master/packages/embla-carousel-auto-height) | <a href="https://bundlephobia.com/result?p=embla-carousel-auto-height@latest"><img src="https://img.shields.io/bundlephobia/minzip/embla-carousel-auto-height?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/embla-carousel-auto-height"><img src="https://img.shields.io/npm/v/embla-carousel-auto-height.svg?color=%23c1a8e2"></a> |
3536
| plugin | [embla-carousel-class-names](https://github.com/davidjerleke/embla-carousel/tree/master/packages/embla-carousel-class-names) | <a href="https://bundlephobia.com/result?p=embla-carousel-class-names@latest"><img src="https://img.shields.io/bundlephobia/minzip/embla-carousel-class-names?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/embla-carousel-class-names"><img src="https://img.shields.io/npm/v/embla-carousel-class-names.svg?color=%23c1a8e2"></a> |
36-
| plugin | [embla-carousel-reactive-utils](https://github.com/davidjerleke/embla-carousel/tree/master/packages/embla-carousel-reactive-utils) | <a href="https://bundlephobia.com/result?p=embla-carousel-reactive-utils@latest"><img src="https://img.shields.io/bundlephobia/minzip/embla-carousel-reactive-utils?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/embla-carousel-reactive-utils"><img src="https://img.shields.io/npm/v/embla-carousel-reactive-utils.svg?color=%23c1a8e2"></a> |
37+
| utility | [embla-carousel-reactive-utils](https://github.com/davidjerleke/embla-carousel/tree/master/packages/embla-carousel-reactive-utils) | <a href="https://bundlephobia.com/result?p=embla-carousel-reactive-utils@latest"><img src="https://img.shields.io/bundlephobia/minzip/embla-carousel-reactive-utils?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/embla-carousel-reactive-utils"><img src="https://img.shields.io/npm/v/embla-carousel-reactive-utils.svg?color=%23c1a8e2"></a> |
3738

3839
#### Playgrounds
3940

@@ -85,7 +86,7 @@ The documentation website is generated using [gatsby](https://github.com/gatsbyj
8586
8687
To develop the docs locally follow these steps:
8788

88-
- Run `yarn install`in the root directory to install dependencies.
89+
- Run `yarn install` in the root directory to install dependencies.
8990
- Run `yarn build` to build the docs (and all other packages).
9091
- Run `yarn start` to start the dev environment of the docs at `localhost:8000`.
9192
- Make sure the `.mdx` file you're working on has a header formatted like this:

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@
125125
<img src="https://avatars2.githubusercontent.com/u/32337092?s=120&v=4" title="horseeyephil" width="50" height="50" style="max-width: 100%" />
126126
</a><a href="https://github.com/nikrowell">
127127
<img src="https://avatars2.githubusercontent.com/u/260039?s=120&v=4" title="nikrowell" width="50" height="50" style="max-width: 100%" />
128+
</a><a href="https://github.com/mujahidfa">
129+
<img src="https://avatars2.githubusercontent.com/u/17759705?s=120&v=4" title="mujahidfa" width="50" height="50" style="max-width: 100%" />
128130
</a><a href="https://github.com/romellem">
129131
<img src="https://avatars2.githubusercontent.com/u/8504000?s=120&v=4" title="romellem" width="50" height="50" style="max-width: 100%" />
130132
</a><a href="https://github.com/LucasMariniFalbo">
@@ -141,8 +143,6 @@
141143
<img src="https://avatars2.githubusercontent.com/u/14075940?s=120&v=4" title="sedlukha" width="50" height="50" style="max-width: 100%" />
142144
</a><a href="https://github.com/allen-garvey">
143145
<img src="https://avatars2.githubusercontent.com/u/9314727?s=120&v=4" title="allen-garvey" width="50" height="50" style="max-width: 100%" />
144-
</a><a href="https://github.com/SaizFerri">
145-
<img src="https://avatars2.githubusercontent.com/u/19834971?s=120&v=4" title="SaizFerri" width="50" height="50" style="max-width: 100%" />
146146
</a>
147147
</p>
148148
</div>

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"packages/embla-carousel-svelte",
2222
"packages/embla-carousel-docs",
2323
"packages/embla-carousel-autoplay",
24+
"packages/embla-carousel-auto-scroll",
2425
"packages/embla-carousel-auto-height",
2526
"packages/embla-carousel-class-names",
2627
"packages/embla-carousel-reactive-utils",

packages/embla-carousel-auto-height/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@
125125
<img src="https://avatars2.githubusercontent.com/u/32337092?s=120&v=4" title="horseeyephil" width="50" height="50" style="max-width: 100%" />
126126
</a><a href="https://github.com/nikrowell">
127127
<img src="https://avatars2.githubusercontent.com/u/260039?s=120&v=4" title="nikrowell" width="50" height="50" style="max-width: 100%" />
128+
</a><a href="https://github.com/mujahidfa">
129+
<img src="https://avatars2.githubusercontent.com/u/17759705?s=120&v=4" title="mujahidfa" width="50" height="50" style="max-width: 100%" />
128130
</a><a href="https://github.com/romellem">
129131
<img src="https://avatars2.githubusercontent.com/u/8504000?s=120&v=4" title="romellem" width="50" height="50" style="max-width: 100%" />
130132
</a><a href="https://github.com/LucasMariniFalbo">
@@ -141,8 +143,6 @@
141143
<img src="https://avatars2.githubusercontent.com/u/14075940?s=120&v=4" title="sedlukha" width="50" height="50" style="max-width: 100%" />
142144
</a><a href="https://github.com/allen-garvey">
143145
<img src="https://avatars2.githubusercontent.com/u/9314727?s=120&v=4" title="allen-garvey" width="50" height="50" style="max-width: 100%" />
144-
</a><a href="https://github.com/SaizFerri">
145-
<img src="https://avatars2.githubusercontent.com/u/19834971?s=120&v=4" title="SaizFerri" width="50" height="50" style="max-width: 100%" />
146146
</a>
147147
</p>
148148
</div>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
docs
2+
package.json
3+
package-lock.json
4+
yarn.lock
5+
node_modules
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
module.exports = {
2+
parser: '@typescript-eslint/parser',
3+
parserOptions: {
4+
ecmaVersion: 2018,
5+
sourceType: 'module'
6+
},
7+
extends: [
8+
'eslint:recommended',
9+
'plugin:prettier/recommended',
10+
'plugin:@typescript-eslint/eslint-recommended',
11+
'plugin:@typescript-eslint/recommended'
12+
],
13+
rules: {
14+
'no-debugger': 2,
15+
'no-console': 2,
16+
'@typescript-eslint/no-inferrable-types': 'off',
17+
'@typescript-eslint/no-explicit-any': 'off',
18+
'@typescript-eslint/ban-types': [
19+
'error',
20+
{
21+
types: {
22+
'{}': false
23+
},
24+
extendDefaults: true
25+
}
26+
]
27+
}
28+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('../../.prettierrc.js')
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
<br />
2+
<div align="center">
3+
<p align="center">
4+
<a href="https://www.embla-carousel.com/"><img width="100" height="100" src="https://www.embla-carousel.com/embla-logo.svg" alt="Embla Carousel">
5+
</a>
6+
</p>
7+
8+
<p align="center">
9+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/npm/l/embla-carousel?color=%238ab4f8"></a>
10+
<a href="https://www.npmjs.com/package/embla-carousel-auto-scroll"><img src="https://img.shields.io/npm/v/embla-carousel-auto-scroll.svg?color=%23c1a8e2"></a>
11+
<a href="https://github.com/davidjerleke/embla-carousel/actions?query=workflow%3A%22Continuous+Integration%22"><img src="https://img.shields.io/github/actions/workflow/status/davidjerleke/embla-carousel/cd.yml?color=%238ab4f8"></a>
12+
<a href="https://prettier.io"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?color=%23c1a8e2"></a>
13+
<a href="https://bundlephobia.com/result?p=embla-carousel-auto-scroll@latest"><img src="https://img.shields.io/bundlephobia/minzip/embla-carousel-auto-scroll?color=%238ab4f8&label=gzip%20size">
14+
</a>
15+
</p>
16+
17+
<strong>
18+
<h2 align="center">Embla Carousel Auto Scroll</h2>
19+
</strong>
20+
21+
<p align="center">
22+
<strong>Embla Carousel</strong> is a bare bones carousel library with great fluid motion and awesome swipe precision. It's library agnostic, dependency free and 100% open source.
23+
</p>
24+
25+
<br>
26+
27+
<p align="center">
28+
<strong>
29+
<code>&nbsp;<a href="https://www.embla-carousel.com/examples/predefined/">Examples</a>&nbsp;</code>
30+
</strong>
31+
</p>
32+
33+
<p align="center">
34+
<strong>
35+
<code>&nbsp;<a href="https://www.embla-carousel.com/examples/generator/">Generator</a>&nbsp;</code>
36+
</strong>
37+
</p>
38+
39+
<p align="center">
40+
<strong>
41+
<code>&nbsp;<a href="https://www.embla-carousel.com/get-started/#choose-installation-type">Installation</a>&nbsp;</code>
42+
</strong>
43+
</p>
44+
</div>
45+
46+
<br>
47+
48+
<div align="center">
49+
<strong>
50+
<h2 align="center">Ready for</h2>
51+
</strong>
52+
53+
<p align="center">
54+
<a href="https://www.embla-carousel.com/get-started/module/">
55+
<img src="https://www.embla-carousel.com/javascript-logo.svg" width="40" height="40" />
56+
</a>
57+
&nbsp;
58+
<a href="https://www.embla-carousel.com/get-started/module/">
59+
<img src="https://www.embla-carousel.com/typescript-logo.svg" width="40" height="40" />
60+
</a>
61+
&nbsp;
62+
<a href="https://www.embla-carousel.com/get-started/react/">
63+
<img src="https://www.embla-carousel.com/react-logo.svg" width="40" height="40" />
64+
</a>
65+
&nbsp;
66+
<a href="https://www.embla-carousel.com/get-started/vue/">
67+
<img src="https://www.embla-carousel.com/vue-logo.svg" width="40" height="40" />
68+
</a>
69+
&nbsp;
70+
<a href="https://www.embla-carousel.com/get-started/svelte/">
71+
<img src="https://www.embla-carousel.com/svelte-logo.svg" width="40" height="40" />
72+
</a>
73+
&nbsp;
74+
<a href="https://www.embla-carousel.com/get-started/solid/">
75+
<img src="https://www.embla-carousel.com/solid-logo.svg" width="40" height="40" />
76+
</a>
77+
</p>
78+
</div>
79+
80+
<br>
81+
82+
<div align="center">
83+
<strong>
84+
<h2 align="center">Contributors</h2>
85+
</strong>
86+
<p align="center">
87+
Thank you to all contributors for making <a href="https://www.embla-carousel.com/">Embla Carousel</a> awesome! <a href="https://github.com/davidjerleke/embla-carousel/blob/master/CONTRIBUTING.md">Contributions</a> are welcome.
88+
</p>
89+
<p align="center">
90+
<a href="https://github.com/davidjerleke">
91+
<img src="https://avatars2.githubusercontent.com/u/11529148?s=120&v=4" title="davidjerleke" width="50" height="50" style="max-width: 100%" />
92+
</a><a href="https://github.com/Ronit-gurjar">
93+
<img src="https://avatars2.githubusercontent.com/u/92150685?s=120&v=4" title="Ronit-gurjar" width="50" height="50" style="max-width: 100%" />
94+
</a><a href="https://github.com/zaaakher">
95+
<img src="https://avatars2.githubusercontent.com/u/46135573?s=120&v=4" title="zaaakher" width="50" height="50" style="max-width: 100%" />
96+
</a><a href="https://github.com/xiel">
97+
<img src="https://avatars2.githubusercontent.com/u/615522?s=120&v=4" title="xiel" width="50" height="50" style="max-width: 100%" />
98+
</a><a href="https://github.com/javiergonzalezGenially">
99+
<img src="https://avatars2.githubusercontent.com/u/78730098?s=120&v=4" title="javiergonzalezGenially" width="50" height="50" style="max-width: 100%" />
100+
</a><a href="https://github.com/hamidrezahanafi">
101+
<img src="https://avatars2.githubusercontent.com/u/91487491?s=120&v=4" title="hamidrezahanafi" width="50" height="50" style="max-width: 100%" />
102+
</a><a href="https://github.com/th-km">
103+
<img src="https://avatars2.githubusercontent.com/u/35410212?s=120&v=4" title="th-km" width="50" height="50" style="max-width: 100%" />
104+
</a><a href="https://github.com/openscript">
105+
<img src="https://avatars2.githubusercontent.com/u/1105080?s=120&v=4" title="openscript" width="50" height="50" style="max-width: 100%" />
106+
</a><a href="https://github.com/nwidynski">
107+
<img src="https://avatars2.githubusercontent.com/u/25958801?s=120&v=4" title="nwidynski" width="50" height="50" style="max-width: 100%" />
108+
</a><a href="https://github.com/wopian">
109+
<img src="https://avatars2.githubusercontent.com/u/3440094?s=120&v=4" title="wopian" width="50" height="50" style="max-width: 100%" />
110+
</a><a href="https://github.com/silllli">
111+
<img src="https://avatars2.githubusercontent.com/u/9334305?s=120&v=4" title="silllli" width="50" height="50" style="max-width: 100%" />
112+
</a><a href="https://github.com/anzbert">
113+
<img src="https://avatars2.githubusercontent.com/u/38823700?s=120&v=4" title="anzbert" width="50" height="50" style="max-width: 100%" />
114+
</a><a href="https://github.com/smultar">
115+
<img src="https://avatars2.githubusercontent.com/u/6223536?s=120&v=4" title="smultar" width="50" height="50" style="max-width: 100%" />
116+
</a><a href="https://github.com/sadeghbarati">
117+
<img src="https://avatars2.githubusercontent.com/u/17789047?s=120&v=4" title="sadeghbarati" width="50" height="50" style="max-width: 100%" />
118+
</a><a href="https://github.com/rojadesign">
119+
<img src="https://avatars2.githubusercontent.com/u/35687281?s=120&v=4" title="rojadesign" width="50" height="50" style="max-width: 100%" />
120+
</a><a href="https://github.com/ruijdacd">
121+
<img src="https://avatars2.githubusercontent.com/u/9107610?s=120&v=4" title="ruijdacd" width="50" height="50" style="max-width: 100%" />
122+
</a><a href="https://github.com/pipisasa">
123+
<img src="https://avatars2.githubusercontent.com/u/54534600?s=120&v=4" title="pipisasa" width="50" height="50" style="max-width: 100%" />
124+
</a><a href="https://github.com/horseeyephil">
125+
<img src="https://avatars2.githubusercontent.com/u/32337092?s=120&v=4" title="horseeyephil" width="50" height="50" style="max-width: 100%" />
126+
</a><a href="https://github.com/nikrowell">
127+
<img src="https://avatars2.githubusercontent.com/u/260039?s=120&v=4" title="nikrowell" width="50" height="50" style="max-width: 100%" />
128+
</a><a href="https://github.com/mujahidfa">
129+
<img src="https://avatars2.githubusercontent.com/u/17759705?s=120&v=4" title="mujahidfa" width="50" height="50" style="max-width: 100%" />
130+
</a><a href="https://github.com/romellem">
131+
<img src="https://avatars2.githubusercontent.com/u/8504000?s=120&v=4" title="romellem" width="50" height="50" style="max-width: 100%" />
132+
</a><a href="https://github.com/LucasMariniFalbo">
133+
<img src="https://avatars2.githubusercontent.com/u/9245477?s=120&v=4" title="LucasMariniFalbo" width="50" height="50" style="max-width: 100%" />
134+
</a><a href="https://github.com/LiamMartens">
135+
<img src="https://avatars2.githubusercontent.com/u/5265324?s=120&v=4" title="LiamMartens" width="50" height="50" style="max-width: 100%" />
136+
</a><a href="https://github.com/JoshuaCrewe">
137+
<img src="https://avatars2.githubusercontent.com/u/12238901?s=120&v=4" title="JoshuaCrewe" width="50" height="50" style="max-width: 100%" />
138+
</a><a href="https://github.com/ishaqibrahimbot">
139+
<img src="https://avatars2.githubusercontent.com/u/74908398?s=120&v=4" title="ishaqibrahimbot" width="50" height="50" style="max-width: 100%" />
140+
</a><a href="https://github.com/fcasibu">
141+
<img src="https://avatars2.githubusercontent.com/u/75290989?s=120&v=4" title="fcasibu" width="50" height="50" style="max-width: 100%" />
142+
</a><a href="https://github.com/sedlukha">
143+
<img src="https://avatars2.githubusercontent.com/u/14075940?s=120&v=4" title="sedlukha" width="50" height="50" style="max-width: 100%" />
144+
</a><a href="https://github.com/allen-garvey">
145+
<img src="https://avatars2.githubusercontent.com/u/9314727?s=120&v=4" title="allen-garvey" width="50" height="50" style="max-width: 100%" />
146+
</a>
147+
</p>
148+
</div>
149+
150+
<br>
151+
152+
<div align="center">
153+
<strong>
154+
<h2 align="center">Special Thanks</h2>
155+
</strong>
156+
<p align="center">
157+
Special thanks to <a href="https://github.com/gunnarx2">gunnarx2</a> for creating the React wrapper <a href="https://www.embla-carousel.com/get-started/react/">useEmblaCarousel</a>, to <a href="https://github.com/xiel">xiel</a> for creating the <a href="https://github.com/xiel/embla-carousel-wheel-gestures">Embla Carousel Wheel Gestures</a> plugin, to <a href="https://github.com/LiamMartens">LiamMartens</a> for creating the Solid wrapper <a href="https://www.embla-carousel.com/get-started/solid/">createEmblaCarousel</a>, and to <a href="https://github.com/zaaakher">zaaakher</a> for your continuous and awesome contributions.
158+
</p>
159+
<p align="center">
160+
<a href="https://github.com/gunnarx2"><img src="https://avatars2.githubusercontent.com/u/10469652?s=120&v=4" title="gunnarx2" width="50" height="50" style="max-width:100%;"></a>
161+
<a href="https://github.com/xiel"><img src="https://avatars0.githubusercontent.com/u/615522?s=120&v=4" title="xiel" width="50" height="50" style="max-width:100%;"></a>
162+
<a href="https://github.com/LiamMartens"><img src="https://avatars0.githubusercontent.com/u/5265324?s=120&v=4" title="LiamMartens" width="50" height="50" style="max-width:100%;"></a>
163+
<a href="https://github.com/zaaakher"><img src="https://avatars0.githubusercontent.com/u/46135573?s=120&v=4" title="zaaakher" width="50" height="50" style="max-width:100%;"></a>
164+
</p>
165+
</div>
166+
167+
<br>
168+
169+
<h2 align="center">Open Source</h2>
170+
171+
<p align="center">
172+
<sup>Copyright © 2019-present, David Jerleke.</sup><br>
173+
Embla is <a href="https://github.com/davidjerleke/embla-carousel/blob/master/LICENSE">MIT licensed</a> 💖.
174+
</p>
175+
176+
<p align="center">
177+
<strong>· · ·</strong>
178+
</p>
179+
180+
<p align="center">
181+
Thanks <a href="https://www.browserstack.com">BrowserStack</a>.
182+
</p>
183+
184+
<p align="center">
185+
<a href="https://www.browserstack.com">
186+
<img src="https://www.embla-carousel.com/browserstack-logo.svg" width="45" height="45" />
187+
</a>
188+
</p>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
transform: {
3+
'^.+\\.(t|j)sx?$': 'ts-jest'
4+
},
5+
testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$',
6+
moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
7+
testEnvironment: 'jsdom'
8+
}

0 commit comments

Comments
 (0)