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

iconfont-component

v0.1.0

Published

Automatically generate components based on iconfont.cn

Downloads

21

Readme

npm version

动机

  • 组件化 Icon,由 iconfont.cn 自动生成强类型 Icon Component,并支持 svg。

参数

  • namespace: 唯一标识,默认值为 iconfont
  • iconJsPath: js 生成路径,用于 svg 的使用
  • iconCssPath: css 生成路径
  • iconFontFilePath: font 文件生成路径
  • iconComponentPath: 组件生成路径

约定

  • 仅适用于 react/ts 项目
  • font-family 的命名必须为 [namespace]
  • FontClass/Symbol 前缀必须为 [namespace]-
  • icon 命名连接符使用-, e.g: arrow-left、arrow-right
  • 组件不能使用数字开头的命名方式, e.g: 666-error(❌)、ok-666(✅)、o666k(✅)

使用

  • 安装:yarn add iconfont-component --dev

  • 项目配置:

    • 根目录下生成 icon.js 文件
      const generate = require('iconfont-component')
      const path = require('path')
      function resolve(relativePath) {
        return path.resolve(__dirname, `./${relativePath}`)
      }
      const iconGenerateConfig = {
        namespace: 'icon',
        iconCssPath: resolve('styles/icon.css'),
        iconFontFilePath: resolve('static/fonts'),
        iconComponentPath: resolve('components/Icon/index.tsx'),
      }
      generate(iconGenerateConfig)
    
    • package.json 新增 script: node icon.js
    • 生成 icon:命令行输入yarn icon [iconfont url]. e.g: yarn icon //at.alicdn.com/t/font_1076605_p8g2n70z31.css or yarn icon //at.alicdn.com/t/font_1076605_p8g2n70z31.js or yarn icon //at.alicdn.com/t/font_1076605_p8g2n70z31
  • 全局引入 css 路径[iconCssPath]

  • 组件 Icon 的引入

    import Icon, { IconClass } from '@/components/Icon'
    function IconSample(){
      return <Icon type={IconClass.MENU} />
    }
    // 如果需要使用svg的形式 props中添加参数symbol,且需要手动引入iconJsPath生成的文件,eg: <Icon type={IconClass.MENU} symbol/>