boxicons/README.md
2018-06-23 15:23:43 +05:30

1.9 KiB

BoxIcons

GitHub issues GitHub license

Twitter Donate

High Quality web friendly icons

'Boxicons' is a carefully designed open source iconset with 350+ icons. It's crafted to look enrich your website/app experience. You can check out all the icons here!

Installation

To install via npm, simply do the following:

$ npm install boxicons --save

import the module

import 'boxicons/css/boxicons.css';

Usage

  1. 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.0.5/css/boxicons.min.css">
  <!-- or -->
  <link rel="stylesheet"
  href="https://unpkg.com/boxicons@1.0.5/css/boxicons.min.css">
</head>
  1. To use an icon on your page, add a class 'bx' and seperate class with the icons name with a prefix 'bx-':
<i class="bx bx-hot"></i>

Check out all the icons here!

License

Boxicons is licensed under the MIT license. (http://opensource.org/licenses/MIT)

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