smoovy is a collection of small and useful js packages preventing copy & paste. The goal is to use as few dependencies as possible to guarantee a small final bundle. Also to keep the code clean, small and simple.
Name | Version | Size |
---|---|---|
@smoovy/scroller | ||
@smoovy/observer | ||
@smoovy/tween | ||
@smoovy/ticker | ||
@smoovy/utils |
Choose a package you want to install. It's as easy as that:
npm install --save @smoovy/<package>
- 📦 Create
@smoovy/parallax
(parallax effect math) - 📦 Create
@smoovy/timeline
(timeline for tweens) - 📦 Create
@smoovy/text-split
(easy text splitting) - 💡 Improve tween demos
- 💡 Improve documentation
- 💡 Improve testing
- 💡 Improve code coverage
This is a simple monorepo consisting of some of the packages mentioned above.
Every command related to a package will be executed from the root directory via
scripty
To ensure the best result, packages are created with rollup. The following formats are supported: cjs
, umd
and esm
.
npm run build:package <name>
Packages will be tested with jest
and puppeteer
. The dist files will be used for testing.
npm run test:package <name>
The demo will be served and bundled with parcel
. Every demo must have a index.html
file.
The source files will be used for the demo.
npm run serve:package <name> [<demo>, default]
The TSLinter
is used for linting packages. Everything except the src
folder will be ignored.
npm run lint:package <name>
See the LICENSE file for license rights and limitations (MIT).