npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vega-icons

v1.0.11

Published

This repository is your one-stop shop for generating React icon components directly from your Figma designs. It automates the process of exporting SVGs, converting them into customizable React components, and bundling them for easy use in your projects.

Downloads

627

Readme

OK, here's the README with explanations tailored to the provided figma.config.js:

# vega-icons

This repository is your one-stop shop for generating React icon components directly from your Figma designs.  It automates the process of exporting SVGs, converting them into customizable React components, and bundling them for easy use in your projects.

## Features

* **Figma Integration:**  Seamlessly connects to your Figma design files to extract icons.
* **React Component Generation:**  Transforms SVGs into reusable React components using SVGR.
* **TypeScript Support:** Generates TypeScript type definitions for a better development experience.
* **SVG Optimization:**  Optimizes SVGs with SVGO to reduce file size and improve performance.
* **Color Customization:**  Converts all icon colors to `currentColor` for dynamic styling.

## Prerequisites

* **Node.js and Yarn:** Ensure you have Node.js and Yarn installed on your system.
* **Figma Personal Access Token:** Obtain a personal access token from your Figma account settings.
* **Figma File ID:**  Locate the unique ID of your Figma file containing the icons.

## Setup

1. **Clone the repository:**

```bash
git clone <repository-url>
  1. Install dependencies:
yarn install
  1. Set up environment variables:
  • Create a .env file in the project's root directory.
  • Add your Figma credentials:
  • https://www.figma.com/developers/api
FILE_ID=<your-figma-file-id>
FIGMA_TOKEN=<your-figma-personal-access-token>

Usage

  1. Export Icons and Components:
yarn export

This command will:

  • Fetch SVGs from the "Icon" page in your Figma file.
  • Optimize the SVGs using SVGO.
  • Convert SVGs into React components (.tsx files) and place them in the src/output directory.
  • Run the post-export script to clean up the generated index.ts file, removing duplicates and file extensions from import statements. (only works at one pointed file at a time)
  1. Bundle Components (Optional):
  • If you want to bundle all React components into a single file:
npm run build

This will create a dist/index.js file containing all your bundled icon components.

  1. Use in Your Project:
  • Install the vega-icons package in your main project:
yarn add vega-icons 
# or 
npm install vega-icons
  • Import and use your icon components:
import { IconName } from 'vega-icons'; 

// In your component:
<IconName /> 

Important Notes:

  • Ensure the @svgr/plugin-jsx plugin is installed (yarn add -D @svgr/plugin-jsx) for React component generation.
  • Customize the figma.config.js if your Figma setup or desired output structure is different.
  • Consider adding automated tests and documentation to improve maintainability.

Let me know if you have any specific questions or want to add more details to your README!