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

@stefanprobst/next-svg

v4.2.1

Published

Next.js plugin to optimize svg images with [SVGO v2](https://github.com/svg/svgo). Output can be used with `next/image` by default, or as a React component when imported with a resource query.

Downloads

130

Readme

next-svg

Next.js plugin to optimize svg images with SVGO v2. Output can be used with next/image by default, or as a React component when imported with a resource query.

The current version generates a thin wrapping component around a svg <use> element.

How to install

yarn add @stefanprobst/next-svg`

How to use

Add the plugin to the Next.js configuration:

// next.config.mjs
import createSvgPlugin from '@stefanprobst/next-svg'

/** @type {import('next').NextConfig} */
const nextConfig = {}

const withSvg = createSvgPlugin({
  // id: '__root__',
  // svgoPlugins: [],
})

export default withSvg(nextConfig)

There are three options for importing an svg image:

Use with next/image

By default, the svg image will be imported for use with next/image. This is also the default next behavior.

import Image from 'next/image'
import RocketAsset from '../public/rocket.svg'

export default function HomePage() {
  return (
    <main>
      <Image src={RocketAsset} alt="Cartoon rocket" />
    </main>
  )
}

Use as a React component with inlined svg

When used with a ?inline resource query, the import returns a React component which inlines the svg as jsx. This is similar to what svgr does.

import RocketComponent from '../public/rocket.svg?inline'

export default function HomePage() {
  return (
    <main>
      <RocketComponent aria-label="Cartoon rocket" />
    </main>
  )
}

Alternatively, the ?inline-icon resource query will add a default width and height of 1em.

Use as a React component with <use>

When used with a ?symbol resource query, the import returns a React component which references the svg image via <use>.

import RocketComponent from '../public/rocket.svg?symbol'

export default function HomePage() {
  return (
    <main>
      <RocketComponent aria-label="Cartoon rocket" />
    </main>
  )
}

Alternatively, the ?symbol-icon resource query will add a default width and height of 1em.

Plugin options

  • id: Added to the image's root svg element, so it can be refereced via <use href="#id">. (Optional)
  • svgoPlugins: Add svgo plugins. By default, the base svgo preset with removeViewBox disabled, and removeDimensions, convertStyleToAttrs and prefixIds enabled is added. (Optional)

Types

When using typescript, add the following to app.d.ts (or any other .d.ts file referenced in tsconfig.json#include):

/// <reference types="@stefanprobst/next-svg/types" />