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

vite-plugin-font

v4.0.0

Published

An automatic Web Font optimization plugin that supports many platforms such as Vite, Next, Nuxt, and more.

Downloads

66,371

Readme

🔠  vite-plugin-font 2.0 ⚡

中文网字计划

中文 | English

vite-plugin-font is a font building tool for Webfonts that supports the 中文网字计划 and is optimized for performance and simplicity. It can split large fonts into Webfonts.

We provide both a minimal optimization plan for first-screen optimization and a full optimization plan for large text sites, achieving the ultimate optimization of Chinese fonts in the front-end toolchain.

⚡ Feature

  1. ⚙️ Automatic CJK (Chinese, Japanese, and Korean) font splitting, with extremely fast on-demand loading speed
  2. 🚀 Automatically optimize the first screen based on the characters used in the project
  3. 🔄 Automatically convert fonts to the woff2 format, so you don't have to worry about size issues
  4. 🌐 Automatically add local adaptation to reduce content displacement accumulation, with SSR support
  5. 📤 Export font information to support tree shaking optimization
  6. 🎨 Pure CSS, no runtime data, multi-platform adaptation
  7. 📦 Automatically reduce the layout offset of Chinese CLS

| Type | Vite, Astro, Qwik | Nuxt | Next | Webpack, Rspack | | --------------------------------------------- | -------------------------- | ------------- | ------------- | --------------------------- | | Full optimization | ✅ | ✅ | ✅ | ✅ | | Minimal optimization | ✅ | ✅ | ✅ | ✅ |

  1. Full optimization is suitable for blogs and documentation websites that require a large amount of uncertain text. It can achieve full font rendering and has excellent caching performance when used with CDNs.
  2. Minimal optimization is suitable for scenarios with high rendering requirements, such as official websites and large promotion pages. It collects the characters used in your code and only loads these characters, providing excellent rendering performance.

📦 Install

npm i -D vite-plugin-font
import { css, fontFamilyFallback } from '../demo/public/SmileySans-Oblique.ttf';
document.body.style.fontFamily = `"${css.family}", ` + fontFamilyFallback;

✨ Config

Vite

Almost all frameworks that use Vite as the underlying compilation framework can use vite-plugin-font by defining plugins.

// vite.config.js
import { defineConfig } from 'vite';
import Font from 'vite-plugin-font';
export default defineConfig({
    plugins: [Font.vite()],
});

Nuxt

// https://nuxt.com/docs/api/configuration/nuxt-config
import font from 'vite-plugin-font';
export default defineNuxtConfig({
    devtools: { enabled: false },
    // modules: ["module/nuxt"],
    vite: {
        plugins: [font.vite({})],
    },
    compatibilityDate: '2024-10-26',
});

Next

// next.config.mjs
/** @type {import('next').NextConfig} */
const nextConfig = {
    webpack: (config, options) => {
        config.plugins.push(viteFont.webpack());
        return config;
    },
};

export default nextConfig;

Webpack

// webpack.config.js or rspack.config.js
const path = require('path');

module.exports = {
    plugins: [viteFont.webpack()],
};

🚀 Usage

// Automatically inject CSS to import fonts and support tree shaking optimization of font information!
import { css } from '../../demo/public/SmileySans-Oblique.ttf'; // Directly import font files
console.log(css.family, css.weight); // You can get CSS-related data from here

export const App = () => {
    return (
        <div
            style={{
                fontFamily: css.family,
            }}
        ></div>
    );
};

Minimal Optimization

Minimal optimization is suitable for scenarios with high rendering requirements, such as official websites and large promotion pages. It collects the characters used in your code and only loads these characters, providing excellent rendering performance.

Add scanFiles . The approach of Nuxt and Webpack is slightly different, but both involve adding scan files to the options.

// vite.config.js
import { defineConfig } from 'vite';
import Font from 'vite-plugin-font';
export default defineConfig({
    plugins: [
        Font.vite({
            scanFiles: ['src/**/*.{vue,ts,tsx,js,jsx}'], // add this
        }),
    ],
});

Add ?subsets to your links.

// Automatically inject CSS to import fonts and support tree shaking optimization of font information!
- import { css } from '../../demo/public/SmileySans-Oblique.ttf';
+ import { css } from '../../demo/public/SmileySans-Oblique.ttf?subsets';
console.log(css.family, css.weight); // You can get CSS-related data from here

export const App = () => {
    return (
        <div
            style={{
                fontFamily: css.family,
            }}
        ></div>
    );
};

Optimization for individual partitions

Sometimes, we need to package fonts based on different page dimensions, so we can use keys to identify the scope of using scanFiles.

// This will match subset-1
import { css } from '../../demo/public/SmileySans-Oblique.ttf?subsets&key=subset-1';
import { defineConfig } from 'vite';
import Font from 'vite-plugin-font';
export default defineConfig({
    plugins: [
        Font.vite({
            scanFiles: {
                // ?subsets will match default
                default: ['src/**/*.{json,js,jsx,ts,tsx,vue}'],
                'subset-1': ['example/**/*.{json,js,jsx,ts,tsx,vue}'],
            },
        }),
    ],
});

Typescript support

The source code includes the src/font.d.ts file, which you can add to your tsconfig.json.

{
    "compilerOptions": {
        "types": ["vite-plugin-font/src/font"]
    }
}

Input parameters

See the 中文网字计划 documentation for input parameters. Most parameters are universal.