icongo

IconGo

Easily include popular icons in your React projects and provide an easy tool to convert svg into React components.

All Packages

Name	NPM Version	Website
@icongo/bi		#preview
@icongo/bs		#preview
@icongo/di		#preview
@icongo/ei		#preview
@icongo/fa		#preview
@icongo/fc		#preview
@icongo/fg		#preview
@icongo/fi		#preview
@icongo/gi		#preview
@icongo/go		#preview
@icongo/hi		#preview
@icongo/md		#preview
@icongo/pk		#preview
@icongo/ri		#preview
@icongo/scwi		#preview
@icongo/si		#preview
@icongo/sti		#preview
@icongo/tb		#preview
@icongo/uiw		#preview
@icongo/vsc		#preview

Usage

import { DIAndroid } from "@icongo/di";
import { STIApple } from '@icongo/sti/lib/STIApple';

function Demo() {
  return (
    <div>
      <STIApple />
      <DIAndroid />
    </div>
  )
}

icongo

npm i icongo

Usage: icongo [options] [--help|h]

Options:

  --output, -o            Output the svg icon component to the specified directory. Default: "components"
  --source, -s            svg icon folder. Default: "icons"
  --prefix                SVG component name prefix.
  --filter                Matching some icons does not generate components.
  --rename, -r            Icon rename E.g: '{"jet-pack": "JetPack1"}'.
  --config, -c            SVGR supports project configuration files for SVGR, SVGO and Prettier.
  --version, -v           Show version number
  --help, -h              Displays help information.

Example:
  npm icongo --output components
  npm icongo --source icons
  npm icongo --source icons --config='{"svgProps": {"viewBox": "0 0 20 20"}}'
  npm icongo -s svg -o src -r '{"jet-pack": "JetPack1"}'
  npm icongo --source icons --filter='(calendar).svg'
  npm s2r --source icons

Usage

{
  "name": "@wcjiang/icons",
  "version": "0.0.1",
  "main": "./lib/index.js",
  "module": "./esm/index.js",
  "types": "./lib/index.d.ts",
  "scripts": {
    "build": "tsbb build",
    "start": "icongo --prefix BS --source data/icons -o ./src"
  },
  "devDependencies": {
    "icongo": "*",
    "tsbb": "^3.7.6"
  }
}

Docker

The Icons search website can be deployed to your personal server via docker.

docker pull wcjiang/icongo
# Or
docker pull ghcr.io/jaywcjlove/icongo:latest

docker run --name icongo --rm -d -p 9112:80 wcjiang/icongo:latest
# Or
docker run --name icongo -itd -p 9112:80 wcjiang/icongo:latest
# Or
docker run --name icongo -itd -p 9112:80 ghcr.io/jaywcjlove/icongo:latest

Visit the following URL in your browser:

http://localhost:9112/

License

Licensed under the MIT License.