mirror of https://github.com/atisawd/boxicons.git synced 2024-11-13 19:04:52 +01:00

High Quality web friendly icons

Find a file

atisawd 4640719aa6 1.5.1		2018-07-04 09:30:56 +05:30
dist	Latest built box-icon-element	2018-06-30 17:43:34 -04:00
src	1.5.0	2018-07-03 12:18:00 +05:30
static	1.5.1	2018-07-04 09:30:56 +05:30
.babelrc	Initial commit	2018-06-15 13:20:17 +05:30
.eslintrc.json	Initial commit	2018-06-15 13:20:17 +05:30
.gitignore	Initial commit	2018-06-15 13:20:17 +05:30
.nojekyll	Initial commit	2018-06-15 13:20:17 +05:30
.svgo.yml	Optimize SVG files	2018-06-23 13:57:20 +02:00
404.html	1.1.0	2018-06-30 01:30:13 +05:30
CNAME	cname-change	2018-06-15 14:01:15 +05:30
dev.box-icon-element.html	1.5.0	2018-07-03 12:18:00 +05:30
index.html	1.5.1	2018-07-04 09:30:35 +05:30
package-lock.json	1.5.0	2018-07-03 12:18:00 +05:30
package.json	1.5.1	2018-07-04 09:30:35 +05:30
README.md	1.5.1	2018-07-04 09:30:56 +05:30
webpack.config.js	Bug fixes to css + Docs + output custom element bundle to `dist/` folder	2018-06-30 16:10:38 -04:00

README.md

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>

Check out all the icons here!

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