shittyicons
v0.0.14
Published
Shitty Icons is a crappy handdrawn icon library built to seamlessly integrate with any project.
Downloads
21
Maintainers
greenestgoatReadme
Installation
CDN
Import Shitty Icons using CDN. The import-min.js file will automatically import all styles and JavaScript files into the <head>.
<script type="module" src="https://unpkg.com/shittyicons"></script>🚧 Specific Version
<script type="module" src="https://unpkg.com/shittyicons@latest"></script>NPM
Install Shity Icons using npm and node.
npm install shittyiconsImport
Import icon definitions from shityicons.
index.js
import shittyIcons from 'shityicons';
document.addEventListener('DOMContentLoaded', () => {
shittyIcons.replaceIcons();
});Usage
Use the <icon-name> tag in HTML markup. Refer to the Icon Docs for more guidance on using each icon. That's it 🎉.
HTML
<!-- example icon -->
<i shitty-icon="archive"></i>
<!-- using vanilla js with no framework -->
<script>
document.addEventListener('DOMContentLoaded', () => {
window.shittyIcons.replaceIcons();
});
</script>Check out the demo on codepen.
Copyright and license
Licensed under the MIT License, Copyright © 2024-present GreenestGoat.
See LICENSE for more information.