Code Monkey home page Code Monkey logo

material-ui-customizable-icons's Introduction

material-ui-customizable-icons

A set of minimalistic customizable material design SVG-icon components for React.

Requirements

  • Node 7.5.0 or newer (not tested on earlier versions)
  • Typescript 2.1.5 or newer (not tested on earlier versions)
  • Babel 6.2.2 or newer (not tested on earlier versions)

Required Knowledge

I recommend that you get to know React and Material-UI.

Installation

npm i material-ui-customizable-icons --save

Usage

Once installed, just import and use the component:

import React from 'react';
import Active from 'material-ui-customizable-icons/Active';

const className = 'custom-icon';
const viewBox = '0 0 48 48';
const transform = 'scale(2)';
const style = {
  width: '48px',
  height: '48px',
};
const pallet = {
  circle: 'rgba(169, 169, 169, 1)',
  tick: 'rgba(255, 255, 255, 1)',
};

const Example = () => (
  <Active
    className={className}
    style={style}
    transform={transform}
    pallet={pallet}
  />
);

export default Example;

Common Properties

Props Options Default Description
className String '' Adds custom class to SVG container.
style Object {} Adds custom inline styles to SVG container.
viewBox String '0 0 24 24' Defines view-box attribute of SVG container.
transform String '0 0 24 24' The transform property applies a 2D or 3D transformation to an element.
pallet Object {} Component-specific colors pallet.

Components list and their specific pallets:

Component Preview Pallet properties to specify colors for
Active Active Icon circle, tick
Inactive Inactive Icon circle, tick, crossing
ChevronUp ChevronUp Icon primary
ChevronDown ChevronDown Icon primary
ChevronLeft ChevronLeft Icon primary
ChevronRight ChevronRight Icon primary
ArrowUp ArrowUp Icon primary
ArrowDown ArrowDown Icon primary
ArrowLeft ArrowLeft Icon primary
ArrowRight ArrowRight Icon primary
CaretUp CaretUp Icon primary
CaretDown CaretDown Icon primary
CaretLeft CaretLeft Icon primary
CaretRight CaretRight Icon primary
ViewArticles ViewArticles Icon primary
ViewGrid ViewGrid Icon primary
ViewHeadlines ViewHeadlines Icon primary
ViewList ViewList Icon primary
Hamburger Hamburger Icon primary
Edit Edit Icon primary
Cancel Cancel Icon primary
Undo Undo Icon primary
Erase Erase Icon primary
Save Save Icon primary
Delete Delete Icon cap, bucket, cross
MoveUp MoveUp Icon arrow, strip
MoveDown MoveDown Icon arrow, strip
MoveLeft MoveLeft Icon arrow, strip
MoveRight MoveRight Icon arrow, strip
Search Search Icon stick, ring
SearchPlus SearchPlus Icon stick, ring, plus
SearchMinus SearchMinus Icon stick, ring, minus
Github Github Icon cat, ring

Contribute

  1. Submit an issue
  2. Fork the repository
  3. Create a dedicated branch (never ever work in master)
  4. The first time, run command: yarn into the directory
  5. Fix bugs or implement features

Future

  • Fix distribution type definitions to handle "import {...} from 'material-ui-customizable-icons'" imports
  • Add tests
  • Add examples directory

License

This project is licensed under the terms of the MIT license

material-ui-customizable-icons's People

Contributors

gordienkotolik avatar

Watchers

 avatar  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.