README
Aqua ·
Native DOM enhancements
Getting started
Full documentation, demos, and example, visit aqua.mauss.dev
Installing
npm install @ignatiusmb/aqua
or use with CDN via UNPKG or jsDelivr
<!-- Full Package via jsDelivr -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ignatiusmb/aqua@20.3.3/lib/aqua.min.css" />
<script defer src="https://cdn.jsdelivr.net/npm/@ignatiusmb/aqua@20.3.3/lib/aqua.min.js"></script>
<!-- Full Package via UNPKG -->
<link rel="stylesheet" href="https://unpkg.com/@ignatiusmb/aqua@20.3.3/lib/aqua.min.css" />
<script defer src="https://unpkg.com/@ignatiusmb/aqua@20.3.3/lib/aqua.min.js"></script>
<!-- Callback Only via jsDelivr/UNPKG (choose either one) -->
<script defer src="https://cdn.jsdelivr.net/npm/@ignatiusmb/aqua@20.3.3/lib/aqua.cbs.js"></script>
<script defer src="https://unpkg.com/@ignatiusmb/aqua@20.3.3/lib/aqua.cbs.js"></script>
Usage
Usage with both npm and CDN requires the stylesheet, so either use a bundler to package your app with it or link it through the head, whichever works for you.
import '@ignatiusmb/aqua/lib/aqua.min.css';
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ignatiusmb/aqua@20.3.3/lib/aqua.min.css" />
<!-- or -->
<link rel="stylesheet" href="https://unpkg.com/@ignatiusmb/aqua@20.3.3/lib/aqua.min.css" />
Contributing
To start developing and test in the docs, run
# Watch source files
npm run docs
then, spawn new terminal and run
cd docs
# Run on first time
npm install
# Use local package
npm install ..
npm run dev
Building from source
npm run bundle
@ignatiusmb/aqua - MIT License
Copyright © 2019 – 2020 Ignatius Bagussuputra