Giter VIP home page Giter VIP logo

umi-plugin-antd-type-icon's Introduction

umi-plugin-antd-type-icon

NPM version NPM downloads

Add <Icon type="iconType" /> component for antd@4 and only import icons you need.

  • When to use this plugin?

If you want to render antd icon dynamically, this plugin could render icons in a scope which you specified instead of importing all antd icons.

Install

# or yarn
$ npm install umi-plugin-antd-type-icon --save

Usage

1. Configure in .umirc.js,

export default {
  plugins: [
    'umi-plugin-antd-type-icon',
  ],
  icons: [
    'UpOutlined',
    {
      QuestionOutlined: 'Question',
      PlusOutlined: ['PlusOutlined', 'Plus'],
    },
  ],
}

2. Use in component

import React from 'react';
import { Icon } from 'umi';

const FooComponent = props => {
  const { type } = props; // 'type' could be: 'UpOutlined', 'Question', 'PlusOutlined', 'Plus'
  return (
    <div>
      <Icon type={type} />
    </div>
  );
};

Options

icons

An array to specify which icons you need. Support 3 forms:

  1. Origin icon type in antd

Like 'UpOutlined' which is origin from antd Icons.

  1. Map origin type to another type

Like { QuestionOutlined: 'Question' }, 'QuestionOutlined' is origin from antd, then you can use it as 'Question' type.

  1. Map origin type to a group of types

Like { PlusOutlined: ['PlusOutlined', 'Plus'] }, 'PlusOutlined' is origin from antd, then you can use it as 'PlusOutlined' or 'Plus' type.

Extra

Icon type mapping string should not duplicate.

LICENSE

MIT

umi-plugin-antd-type-icon's People

Contributors

jtsang4 avatar

Watchers

 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.