Code Monkey home page Code Monkey logo

image-trace-loader's Introduction

npm

Image Trace Loader

Loads images and exports traced outlines as image/svg+xml URL-encoded data

Install

npm install --save-dev image-trace-loader

Inspiration

I saw Mikael Ainalem's fantastic CodePen showcasing this technique, and I wanted a way to automate the process.

Usage

The image-trace-loader loads your image and exports the url of the image as src and the image/svg+xml URL-encoded data as trace.

import { src, trace } from './image.png';

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.(gif|png|jpe?g)$/i,
        use: [
          {
            loader: 'image-trace-loader'
          }
        ]
      }
    ]
  }
}

It can also be used in conjunction with url-loader or file-loader.

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.(gif|png|jpe?g)$/i,
        use: [
          {
            loader: 'image-trace-loader'
          },
          {
            loader: 'url-loader',
            options: {
              limit: 8192
            }
          }
        ]
      }
    ]
  }
}

Options

The loader options allows you to specify values for all the parameters of the Potrace class, with the addition of skipTraceIfBase64.

Name Type Default Description
turnPolicy {String} TURNPOLICY_MINORITY How to resolve ambiguities in path decomposition. Possible values are TURNPOLICY_BLACK, TURNPOLICY_WHITE, TURNPOLICY_LEFT, TURNPOLICY_RIGHT, TURNPOLICY_MINORITY, TURNPOLICY_MAJORITY. Refer to page 4 of this document for more information
turdSize {Number} 100 Suppress speckles of up to this size. Larger values significantly reduce the size of the traced outline
alphaMax {Number} 1 Corner threshold parameter. Lower values results in rougher edges, but significantly reduces the size of the traced outline
optCurve {Boolean} true Curve optimization
optTolerance {Number} 0.2 Curve optimization tolerance
threshold {Number|String} THRESHOLD_AUTO Threshold below which the color is considered color. Should be a number in range 0..255 or THRESHOLD_AUTO in which case threshold will be selected automatically using Algorithm For Multilevel Thresholding
flipColors {Boolean} false Specifies whether fill color and background color should be swapped
color {String} COLOR_AUTO Fill color. COLOR_AUTO will extract and use the most prominent color of the source image
background {String} COLOR_TRANSPARENT Background color
skipTraceIfBase64 {Boolean} false If set to true, will not generate a traced outline if the image already is base64 encoded. Useful when the inlined base64 representation is enough, and you don't want to bloat your files with unused traces

image-trace-loader's People

Contributors

emiltholin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

image-trace-loader's Issues

TypeError: unsupported file type: undefined (file: undefined)

Hi, I'm trying to use your package together with [email protected], but I'm getting an error error - ./public/assets/handshake.png TypeError: unsupported file type: undefined (file: undefined).

My next.config.js where I push webpack config:

const { i18n } = require("./next-i18next.config");

/** @type {import('next').NextConfig} */
const nextConfig = {
  reactStrictMode: true,
  i18n,
  trailingSlash: true,
  webpack(config) {
    config.module.rules.push(
      {
        type: "asset",
        resourceQuery: /url/,
      },
      {
        test: /\.svg$/,
        use: {
          loader: "@svgr/webpack",
          options: {
            svgoConfig: {
              plugins: [
                {
                  name: "preset-default",
                  params: {
                    overrides: {
                      mergePaths: false,
                    },
                  },
                },
                "prefixIds",
              ],
            },
          },
        },
      },
      {
        test: /\.(png|jpe?g|gif|jp2|webp)$/,
        use: [
          {
            loader: "image-trace-loader",
          },
        ],
      }
    );

    return config;
  },
  images: {
    domains: ["images.unsplash.com"],
  },
  async redirects() {
    return [
      {
        source: "/polityka-prywatnosci",
        destination: "/privacy-policy",
        permanent: true,
      },
    ];
  },
};

module.exports = nextConfig;

Output svg trace to file

This is an awesome package! Thank you for building this, Emil.

It would be great to have an option that outputs the svg trace to a file so that I can render it server-side (and not need to wait for javascript to load and execute on the client for example).

I'll have a look at implementing this myself, but I'm not very familiar with webpack, so any tips would be much appreciated!

How to do image dynamic import?

It's my code

const {book} = this.props
const urlImage = `../../../../..${book.image}`
const image = require(urlImage)

I can next issue http://prntscr.com/hsknvf .
Uncaught Error: Cannot find module "."
at webpackMissingModule

How i can to do dynamic import?

image trace loader performance?

Hello,

Thanks for the great project! And we use it in our project, it works fine if images not so much. And in the production env, there are around 10000+ images. We try to build the project using webpack and it throws out out of memory error. So did you test the image-trace-loader performance?

Thanks

Security Vunerability - Update svgo

The version of svgo in this project has a vunerability in it's js-yaml dependencies. This has been resolved in svgo 3.13.0+. Please update the svgo dependency verion.

Importing images in CSS as background image gets [object Object].

Hi @EmilTholin,

I'm not sure if this is really a bug or that I don't know how to use the plugin, but despite it works fine when importing images in React, when I try to import images in CSS:

main {
    background-image: url('~images/star.png');
}

The result I get in the developer's tools is that the content of the URL is an object:

background-image: url([object Object]);

Is there any way to get in CSS the src of the image? Do I need to import images for CSS in a different way? How I can do it?

Thanks in advance.

Regard

Error: Cannot find module 'file-loader'

Hi, I'm trying to use this package in a Next.JS enviroment with typescript and I'm getting this error:

Error: Cannot find module 'file-loader'

My page is

export default function test() {
    return (
        <div>
            <LazyLoadingImage src="../../public/star-1.png" alt="star" width="50px" height="50px" className=""/>
        </div>
      )
}

and my component is:

interface LazyImageProps{
    src: string,
    alt?: string,
    width?: string,
    height?: string,
    className?: string,
}

function LazyLoadingImage({src, alt, className, width, height}: LazyImageProps){
    const [imageLoaded, setImageLoaded] = useState(false);

    // src image and trace image url
    // const { source, trace } = require(`./${src}`);
    const { source, trace } = require(`../../public/star-1.png`);
    return (
        <div className="imageLoader">
            <img 
                src={`./renato.png`} alt={alt} 
                loading="lazy" className={"real-img " + className} 
                width={width} height={height}
                style={{
                    opacity: imageLoaded ? "1" : "0",
                }}
                onLoad={() => setImageLoaded(true)}
            />
            
            <img
                style={{
                    opacity: imageLoaded ? "0" : "1",
                }}
                src={`./renato.png`}
                alt={alt}
            />
        </div>
    )
    
};

I decided to use this image ../../public/star-1.png for testing.

Here is my next.config:

/** @type {import('next').NextConfig} */
const withPWA = require("next-pwa");

const tracedImages = {
  test: /\.(png|jpe?g|gif|jp2|webp)$/,
  use: [
    {
      loader: 'image-trace-loader'
    },
    
  ]
};


module.exports = withPWA({
  pwa: {
    dest: "public",
    register: true,
    disable: process.env.NODE_ENV === 'development',
    skipWaiting: true,
  },
  reactStrictMode: true,
  images: {
    domains: ['codingideas.vercel.app'],
  },
  webpack: (config, options) => {
    config.module.rules.push(tracedImages)
    return config
  }

});

Anyone know what should I do to fix it?

Using CDN Images

Hi,

Wondering if anyone has used this loader with CDN images. My images are on Cloudinary and S3 and I was wondering if there is a use-case with this loader.

Cheers!

Safari 11 - Using file URI causes memory leak.

Hey!

First of all, thank you a lot for this little loader, it's quite useful and well coded, I will probably enjoy making a PR here and there ;)

Safari 11 leaks a lot while trying to process Base64 string pictures and vectors. It sucks because if you have a lot of pictures to load (it's kind of the point of lazy loading), then safari gets a serious heart attack loading your web app.

I guess that we could avoid this problem by setting a new option to serve a file as well as the Base64 string, and by adding a constructor to the exported object who would detect which browser is used if executed on the client (for SSR compatibility) and would change the value of the trace retrieved by the app to a file URL accordingly.

The option would be an array of strings useFileUrlOn who could be set, for example, to ['safari', 'ie'] in order to use file URL instead of data URI on Safari and IE8,9,10,11...

Does it sound good ?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.