44

GitHub - Remix-Design/RemixIcon: Open source neutral style icon system

 4 years ago
source link: https://github.com/Remix-Design/RemixIcon
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

README.md

logo

npm downloads spectrum donate

English | 简体中文

Remix Icon is a set of open-source neutral-style system symbols for designers and developers. Unlike a patchwork icon library, 1500+ icons are all elaborately crafted so that they are born with the gene of readability, consistency and perfect pixels. Each icon was designed in "Outlined" and "Filled" styles based on a 24x24 grid. Of course, all the icons are free for both personal and commercial use.

icon demo View the full set of Remix Icons at remixicon.com.

Usage

Basic Usage

Just click the icons you want from remixicon.com, and the icons will be downloaded directly in SVG format.

We recommend that designers download icons from our website when needed instead of managing all of them in a local folder. The website's search engine allows you to quickly locate the icon you are looking for and the icons on the website are being continuously updated.

Using SVG on the web is as simple as JPEG or PNG. Such as:

<img height="32" width="32" src="img/admin-fill.svg" />

Webfont Usage

Note: You can import Remix Icon with npm install, cdn or download it manually.

Installation

Note: If you'd like to use Remix Icon with a CDN, you can skip this installation step.

npm install remixicon --save

import 'remixicon/fonts/remixicon.css'

import CSS to your main.js

CDN

Copy the following code and add it to the <head> tag of your html document.

<link href="http://cdn.remixicon.com/releases/v1.2.1/remixicon.css" rel="stylesheet">

Download Manually

Download remixicon.css file, add it to the <head> tag of your html document.

Use

Add icon with class name, class name rule: remixicon-{name}-{style}

<i class="remixicon-admin-line"></i>
<i class="remixicon-admin-fill"></i>

Note: You can go to remixicon.com to check the name of the icons. -line means the outlined style icon, and -fill means the filled style icon.

SVG Sprite Usage

Download remixicon.symbol.svg file into your project directory，use icons with the <use> element, such as:

<svg class='remix'>
  <use xlink:href="your-path/remixicon.symbol.svg#remixicon-admin-fill"></use>
</svg>
.remix {
  width: 24px;
  height: 24px;
  fill: #333;
}

Note: remixicon-admin-fill after the # in the above example can be replaced with any valid icon name of Remix Icon. You can go to remixicon.com to check the name of the icons. -line means the outlined style icon, and -fill means the filled style icon.

Contributing

Note: In order to ensure the quality of each icon, we currently do not accept third-party drawn icons. If you want to contribute an icon to Remix Icon, you can create an issue with a screenshot or url to your svg-format file. If you are not famlilar with github, you can also email us directly [email protected].

Icon Request

If there is no suitable icon for your usage scenario, you can create an issue with a title of "Icon request: " and fill the issue template.

Icon Search Keywords

We use tags.json file to manage the search keywords of our website. But at the moment, we don't have a good automatic method to complete the keywords for each icon. So we hope you can help us to improve the tags.json file by creating issues, sending emails or "pull request" of tags.json file to make the seach engine better.

Sub-projects

RemixIcon-Slides PowerPoint and Keynote verison of Remix Icon.

License

Remix Icon is licensed under the Apache License Version 2.0. Feel free to use these icons in you products and distribute them. We would be very grateful if you mention "Remix Icon" in your product info, but it's not required. The only thing we ask is that these icons are not for sale.


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK