Giter Site home page Giter Site logo

zkreations / icons Goto Github PK

View Code? Open in Web Editor NEW
17.0 1.0 1.0 611 KB

Handcrafted line by line, for as little code as possible

Home Page: https://meteoricons.com/

License: MIT License

JavaScript 100.00%
icon-pack open-source svg-icons svg-sprites icons svg icon icons-pack iconset svgo

icons's Introduction

cover

Demo en vivo โ†’

Release LICENSE

About these icons

SVG icons are scalable, weigh much less than images, are editable with CSS, and much more. However, the main problem (at least for me) is their code, which tends to be very large.

That's why I manually designed the code for each icon in order to make smart decisions to achieve the least amount of code possible. This task was made easier thanks to the svg-path-editor tool. I have named this pack "Meteor icons" and it is open source.

Installation

npm install meteor-icons

Getting Started

The following CSS code helps to keep the SVG tag cleaner, and it will also allow you to quickly customize the icons:

.i {
  stroke-width: var(--i-stroke, 2);
  width: var(--i-size, 24px);
  height: var(--i-size, 24px);
  stroke: currentColor;
  stroke-linecap: round;
  stroke-linejoin: round;
  fill: none;
}

You can set the size and thickness with CSS variables:

Variable Default
--i-stroke 2
--i-size 20px

Inline SVG

Choose any icon from the demo page, copy its code, and paste it into your project.

SVG Sprite

Add the svg-sprite.svg file to your project. Now, anywhere in your project, include the icons using this code:

<svg class="i i-github">
  <use href="svg-sprite.svg#github"/>
</svg>

Replace "github" with the name of an icon from the demo page.

Blogger

If your project is a Blogger template, add the icons.xml inclusion. To include it, you will need b:defaultmarkups tags, for example:

<b:defaultmarkups>
  <b:defaultmarkup type="Common">
    <!-- icons.xml here -->
  </b:defaultmarkup>
</b:defaultmarkups>

After including it, you can call any icon anywhere in the template using a b:include tag, for example:

<b:include name='@meteor' data='{ icon: "github" }'/>

Replace "github" with the name of an icon from the demo page.

The inclusion has some parameters that allow you to customize the resulting SVG tag. The available parameters are:

Parameter Description
icon Icon name
class Additional classes
viewbox viewbox attribute
fill fill attribute
width width attribute
height height attribute

Here's an example adding some attributes to the Blogger inclusion:

<b:include name='@meteor' data='{ icon: "github", width: "50px", height: "50px" }'/>

Contributing

All icons are designed by Daniel Abel, but you can help maintain or improve this project by considering the following points:

  • Improve the design and consistency of the icons
  • Keep the SVG code as small as possible
  • In case of requesting an icon, leave a clear example
  • In case of contributing an icon, you must be the original author

If you want, you can also help me maintain this and more projects by buying me a coffee โ˜•. I will appreciate it very much ๐Ÿ‘.

License

Meteor icons is licensed under the MIT License

icons's People

Contributors

danieiabel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

gianles

icons's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.