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

@imjano/iconifont

v1.0.0

Published

Convert SVG files into an icon font library.

Downloads

5

Readme

Iconifont

This Node.js package allows you to transform all SVG files in a directory into four font files: SVG, TTF, WOFF, and WOFF2. Additionally, it generates a CSS stylesheet to facilitate their usage in web projects.

Installation

To install this package, you can use npm:

npm install --save-dev @imjano/iconifont

Usage

Here's an example of how to use this package in a TypeScript project:

import generateIconifont, { IGenerateIconifontArgs } from '@imjano/iconifont'

async function generateFonts() {
	const options: GenerateIconifontArgs = {
		svgDirectory: './my_svg_directory',
		outputFontDirectory: './fonts',
		outputCSSDirectory: './css',
		fontName: 'myIconFont',
		classSuffix: 'icon',
		classAffix: 'font',
		classNotation: 'camelCase',
		baseUnicode: 'E001',
	}

	try {
		await generateIconifont(options)
		console.log('Fonts and stylesheet generated successfully!')
	} catch (error) {
		console.error('An error occurred while generating fonts:', error)
	}
}

| Parameter | Description | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | svgDirectory | The path to the directory containing the SVG files to be used for generating the fonts. | | outputFontDirectory | The path to the directory where the font files (SVG, TTF, WOFF, WOFF2) will be generated. | | outputCSSDirectory | The path to the directory where the CSS stylesheet will be generated. | | fontName | The name to be used for the generated font. | | classSuffix | The suffix to be appended to the classes of the icons in the CSS stylesheet. | | classAffix | The affix to be appended to the font name in the CSS stylesheet. | | classNotation | The notation to be used for naming the classes of the icons in the CSS stylesheet. | | baseUnicode | The base Unicode value to be used for assigning Unicode codes to the icons in the stylesheet. It's recommended to use E001 as it falls within the "Private Use Area" of Unicode, ensuring no conflicts with standard characters. |