Wondering what’s next for npm?Check out our public roadmap! »

    @uiw/icons

    2.5.1 • Public • Published

    uiw-icons

    Packagist Packagist

    The premium icon font for uiwjs Component Library. Designed by @liwen0526.

    Visit https://uiwjs.github.io/icons/ and check out the search feature, which has keywords identifying common icon names and styles. For example, if you search for "arrow" we call up every icon that could possibly be used as an arrow. We've also included each icon's class name for easy copy / pasting when you're developing!

    They are free to use and licensed under MIT. We intend for this icon pack to be used with uiw, but it’s by no means limited to it. Use them wherever you see fit, personal or commercial.

    Installation

    # v1.x +
    npm install uiw-iconfont --save
    # v2.x 
    npm install @uiw/icons --save

    HTML Example

    You can use https://uiwjs.github.io/icons/ to easily find the icon you want to use. Once you've copied the desired icon's CSS classname, simply add the icon and icon's classname, such as apple to an HTML element.

    You need link CSS

    <link rel="stylesheet" type="text/css" href="node_modules/@uiw/icons/w-icon.css">

    Used in Less:

    @import "~@uiw/icons/fonts/w-icon.css";

    Used in JS:

    import '@uiw/icons/fonts/w-icon.css';
    // or
    import '@uiw/icons/fonts/w-icon.less';

    note: It has a w-icon- prefix.

    <i class="w-icon-apple"></i>

    Or use the Unicode, You can use Unicode website to easily find the Unicode icon you want to use.

    <style>
    .iconfont{
      font-family: "w-icon" !important;
      font-size: 16px;
      font-style: normal;
      -webkit-font-smoothing: antialiased;
      -webkit-text-stroke-width: 0.2px;
      -moz-osx-font-smoothing: grayscale;
    }
    </style>
    <span class="iconfont">&#59907;</span>

    Or manually download and link **@uiw/icons** in your HTML, It can also be downloaded via UNPKG:

    <link rel="stylesheet" type="text/css" href="https://unpkg.com/@uiw/icons/fonts/w-icon.css">
    <span class="w-icon-adobe"></span>

    In Webpack

    {
      test: /w-icon\.(eot|ttf|svg)$/,
      use: [
        {
          loader: require.resolve('url-loader'),
          options: { limit: 8192 }
        },
        {
          loader: require.resolve('file-loader'),
          options: {
            name: 'static/fonts/[name].[hash:8].[ext]',
          }
        }
      ]
    },

    React

    Create an Icon component.

    import React from 'react';
    import svgPaths from '@uiw/icons/fonts/w-icon.json';
    
    const renderSvgPaths = (type) => {
      const pathStrings = svgPaths[type];
      if (pathStrings == null) {
        return null
      }
      return pathStrings.map((d, i) => <path key={i} d={d} fillRule="evenodd" />)
    }
    
    export default class Icon extends React.PureComponent {
      render() {
        const { type, color } = this.props;
        if (type == null || typeof type === "boolean") {
          return null;
        }
        return (
          <svg fill={color} viewBox={`0 0 24 24`}>{this.renderSvgPaths(type)}</svg>
        );
      }
    }

    Use the Icon component:

    const demo = () => {
      return (
        <Icon type="heart-on" />
      )
    }

    Development

    Run the npm install to install the dependencies after cloning the project and you'll be able to:

    To build *.svg *.ttf *.woff *.eot files

    npm run font

    To build site and push gh-pages branch

    npm run start

    License

    Created By svgtofont, Licensed under the MIT License.

    Install

    npm i @uiw/icons

    DownloadsWeekly Downloads

    503

    Version

    2.5.1

    License

    MIT

    Unpacked Size

    1.85 MB

    Total Files

    233

    Last publish

    Collaborators

    • avatar