Giter Club home page Giter Club logo

framework7-icons's Introduction

Framework7 Icons

The premium and free iOS-icons font for Framework7.

The font is developed to be used with Framework7, but you can use it wherever you see it fits, personal or commercial. It is free to use and licensed under MIT.

Getting Started

  1. Download and extract the font pack

  2. Copy the framework7-icons.css to your project or add this CSS to your own CSS file:

    @font-face {
      font-family: 'Framework7 Icons';
      font-style: normal;
      font-weight: 400;
      src: url("../fonts/Framework7Icons-Regular.eot");
      src: local('Framework7 Icons'),
         local('Framework7Icons-Regular'),
         url("../fonts/Framework7Icons-Regular.woff2") format("woff2"),
         url("../fonts/Framework7Icons-Regular.woff") format("woff"),
         url("../fonts/Framework7Icons-Regular.ttf") format("truetype");
    }
    
    .f7-icons, .framework7-icons {
      font-family: 'Framework7 Icons';
      font-weight: normal;
      font-style: normal;
      font-size: 28px;
      line-height: 1;
      letter-spacing: normal;
      text-transform: none;
      display: inline-block;
      white-space: nowrap;
      word-wrap: normal;
      direction: ltr;
      -webkit-font-smoothing: antialiased;
      text-rendering: optimizeLegibility;
      -moz-osx-font-smoothing: grayscale;
      -webkit-font-feature-settings: "liga";
      -moz-font-feature-settings: "liga=1";
      -moz-font-feature-settings: "liga";
      font-feature-settings: "liga";
    }
  3. Copy the fonts folder to your project

  4. Ensure the font urls within framework7-icons.css properly reference the fonts path within your project.

  5. Include a reference to the framework7-icons.css file from every webpage you need to use it:

    <link rel="stylesheet" href="path/to/framework7-icons.css">

Or with component:

$ component install nolimits4web/framework7-icons

Or with bower:

$ bower install framework7-icons

Or with npm:

$ npm install framework7-icons

Webpack

When using webpack, you must add loaders for css and fonts.

{ test: /\.css/, loader: 'style-loader!css-loader' },
{ test: /\.(woff|woff2|eot|ttf)$/, loader: 'url-loader?limit=100000' },

Then you can import the module like so:

import 'framework7-icons';

HTML Example

You can use framework7.io or included cheatsheet.html file to easily find the icon you want to use. It’s easy to incorporate icons into your web page. Here’s a small example:

<i class="f7-icons">house</i>

This example uses a typographic feature called ligatures, which allows rendering of an icon glyph simply by using its textual name. The replacement is done automatically by the web browser and provides more readable code than the equivalent numeric character reference.

Styling Icons

Sizing

Framework7 Icons look best at 28px, but if an icon needs to be displayed in an alternative size, just use CSS font-size rule:

.size-14 { font-size: 14px }
.size-28 { font-size: 28px }
.size-32 { font-size: 32px }
.size-56 { font-size: 56px }
<i class="f7-icons size-14">house</i>
<i class="f7-icons size-28">house</i>
<i class="f7-icons size-32">house</i>
<i class="f7-icons size-56">house</i>

Coloring

Using the icon font allows for easy styling of an icon in any color.

.color-black { color: #000 }
.color-white { color: #fff }
<i class="f7-icons color-black">house</i>
<i class="f7-icons color-white">house</i>

Using in data- attributes

Add the following CSS rule:

.f7-icons[data-icon]:before {
    content: attr(data-icon);
    color: inherit;
}

And now you can use it with data- attributes:

<i class="f7-icons" data-icon="house"></i>

Build Instructions

This repo already comes with all the files built and ready to go, but can also build the fonts from the source. Requires Python, FontForge and woff2:

  1. Install FontForge, which is the program that creates the font files from the SVG files:

    $ brew install fontforge ttfautohint

  2. Install woff2

    $ git clone --recursive https://github.com/google/woff2.git $ cd woff2 $ make clean all

  3. Add or subtract files from the src/ folder you'd like to be apart of the font files.

  4. Run the build command:

    python ./build/generate.py

License

Framework7 Icons font is licensed under the MIT license.

framework7-icons's People

Contributors

nolimits4web avatar xster avatar guidezpl avatar litomore avatar

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.