Git Product home page Git Product logo

ss-icon's Introduction

ss-icon

Icon component library. Contains scripts to convert SVGs into usable React component.

Getting started

Prerequisites

The package is hosted at GitHub NPM Package registry. (Not the default NPM registry). Some npm config is required to use this package.

  • Create a .npmrc file at the root folder of your project. Make sure to replace PERSONAL_ACCESS_TOKEN with own PAT from GitHub

      @irfancoder:registry=https://npm.pkg.github.com
      //npm.pkg.github.com/:_authToken=PERSONAL_ACCESS_TOKEN
    
  • Thats it.

Installing

Now you can install the package as usual.

# NPM
npm install @irfancoder/ss-icon

# Yarn
yarn add @irfancoder/ss-icon

Usage

  • For outline icons: @irfancoder/ss-icon/outline
  • For bold icons: @irfancoder/ss-icon/bold

Example:

import { Add } from '@irfancoder/ss-icon/outline'
import { User } from '@irfancoder/ss-icon/bold'

<Add className="" size={20} color="#000"  ... />
<User className="" size={20} color="#000"  ... />

Development

This section is for package development.

Commands to know

yarn install    -   Install dependencies
yarn manifest   -   Create collection of SVG contents in JSON from 'src/icons'
yarn generate   -   Generate the React icon components
yarn build      -   Builds the package

ss-icon's People

Contributors

irfancoder avatar github-actions[bot] avatar

Watchers

James Cloos avatar Ashraf Kamarudin 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.