Installations

npm install embla-carousel-wheel-gestures

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10

Score

99.2

Supply Chain

99.5

Quality

77

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

179

Closed

46

Merged

132

Issues

Open

8

Total

31

Closed

23

Releases

15

v8.0.1

Published on 29 May 2024

Support embla-carousel v8

v8.0.0-rc03

Published on 10 May 2023

embla-carousel v7

v3.0.0

Published on 06 Jul 2022

feat: target option

v2.2.0

Published on 06 May 2022

Shadow DOM Support 🧛🏻‍♀️

v2.1.1

Published on 18 Mar 2022

feat: Global (Default) Options - v2.1.0

v2.1.0

Published on 10 Feb 2022

View all 15 releases

Contributors

6

Unable to fetch Contributors

View all 6 contributors

Languages

2

TypeScript

JavaScript

TypeScript (84.24%)

JavaScript (15.76%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

xiel

Download Statistics

Total Downloads

3,295,372

Last Day

12,099

Last Week

56,700

Last Month

251,677

Last Year

1,962,813

GitHub Statistics

58 Stars

270 Commits

9 Forks

4 Watching

4 Branches

6 Contributors

Bundle Size

7.05 kB

Minified

2.76 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

8.0.1

Package Id

embla-carousel-wheel-gestures@8.0.1

Unpacked Size

111.55 kB

Size

24.42 kB

File Count

22

Publised On

29 May 2024

Total Downloads

Cumulative downloads

Total Downloads

3,295,372

Last day

-11.3%

12,099

Compared to previous day

Last week

-17.6%

56,700

Compared to previous week

Last month

13.8%

251,677

Compared to previous month

Last year

178.8%

1,962,813

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

wheel-gestures

Peer Dependencies

1

embla-carousel

Dev Dependencies

13

@testing-library/react @types/jest bundlewatch embla-carousel eslint-plugin-import eslint-plugin-react eslint-plugin-react-app eslint-plugin-simple-import-sort husky lint-staged tsdx tslib typescript

Versions

Wheel Gestures for Embla Carousel

This plugin adds wheel interactions to the amazing Embla Carousel

NPM

Installation

First you need to follow the installation instructions for Embla Carousel, after that you can add wheel support:

1yarn add embla-carousel-wheel-gestures # npm install --save embla-carousel-wheel-gestures

JavaScript / TypeScript

1import EmblaCarousel from 'embla-carousel'
2import { WheelGesturesPlugin } from 'embla-carousel-wheel-gestures'
3
4// initialize Embla Carousel
5const embla = EmblaCarousel(emblaNode, options, [
6  WheelGesturesPlugin()
7])

React

1import { useEmblaCarousel } from 'embla-carousel-react'
2import { WheelGesturesPlugin } from 'embla-carousel-wheel-gestures'
3
4const EmblaCarouselComponent = ({ children }) => {
5  const [emblaRef, embla] = useEmblaCarousel({ loop: false, skipSnaps: true }, [
6    WheelGesturesPlugin(),
7  ])
8
9  // ...
10}

Examples

Get started instantly with one of the CodeSandboxes below.

JavaScript / TypeScript

React (embla-carousel-react)

Options

wheelDraggingClass

Type: string
Default: is-wheel-dragging

Choose a classname that will be applied to the container during a wheel gesture. Pass an empty string to opt-out.

forceWheelAxis

Type: 'x' | 'y'
Default: undefined

Force an axis on which to listen for wheel events. Useful if you want to slide horizontally when scrolling vertically or vice versa.

target

Type: Element
Default: undefined

Specify the element that should be observed for wheel events.

Global Options

You can also set global options that will be applied to all instances. This allows for overriding the default plugin options with your own:

1WheelGesturesPlugin.globalOptions = {
2  wheelDraggingClass: 'my-class',
3}

OS & Browser Support

Mac OS (Chrome, Firefox, Safari, Edge), Magic Mouse, Magic Trackpad
Windows (Chrome, Firefox, Edge), Microsoft Precision Touchpads

Legacy Browsers

If you need to support IE 10 & 11 you might need to install and add extra polyfills:

1// Adds support old IE >= 10
2import 'core-js/stable'
3import 'events-polyfill/src/constructors/MouseEvent'

Thanks

Kudos to David Jerleke for creating Embla Carousel with its open API 🙏

License

MIT.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More