mirror of
https://github.com/atisawd/boxicons.git
synced 2024-12-22 20:32:38 +01:00
High Quality web friendly icons
dist | ||
src | ||
static | ||
.babelrc | ||
.eslintrc.json | ||
.gitignore | ||
.nojekyll | ||
.svgo.yml | ||
404.html | ||
CNAME | ||
dev.box-icon-element.html | ||
index.html | ||
package-lock.json | ||
package.json | ||
README.md | ||
webpack.config.js |
BoxIcons
High Quality web friendly icons
'Boxicons' is a carefully designed open source iconset with 700+ icons. It's crafted to look enrich your website/app experience.
Announcing Boxicons v1.5.1!
Solid icons have been added with a seperate logos category
You can check out the detailed documentation here
Installation
To install via npm, simply do the following:
$ npm install boxicons --save
import the module
import 'boxicons/css/boxicons.css';
Usage
Using via CSS
- Include the stylesheet on your document's
<head>
<head>
<link rel="stylesheet" href="boxicons.min.css">
</head>
Instead of installing you may use the remote version
<head>
<link rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/boxicons@1.5.1/css/boxicons.min.css">
<!-- or -->
<link rel="stylesheet"
href="https://unpkg.com/boxicons@1.5.1/css/boxicons.min.css">
</head>
- To use an icon on your page, add a class 'bx' and seperate class with the icons name with a prefix 'bx-' for regular icons , 'bxs-' for solid icons and 'bxl-' for logos:
<i class="bx bx-hot"></i>
<i class="bx bxs-hot"></i>
<i class="bx bxl-facebook-square"></i>
License
You can read the license here!
Contributing
Pull requests are the way to go here. I apologise in advance for the slow action on pull requests and issues.
Caught a mistake or want to contribute to the documentation? Edit this page on Github