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

@wanner.work/image

v2.0.0

Published

![image.](docs/lead.svg)

Downloads

1

Readme

image.

image.

An opinionated image component with caching for the web.

Prerequisites

Only use this package if you are building with tailwindcss and the newest version of react.

Installation

  1. Install the package using pnpm: pnpm add @wanner.work/image.
  2. Add the following line to your tailwind.config.js content configuration: (if not already present from different @wanner.work components) "./node_modules/@wanner.work/**/*.{js,ts,jsx,tsx}"

Usage

1. Using the Image component:

import Image from '@wanner.work/image'

export default function MyComponent() {
  return (
    <Image
      src="https://source.unsplash.com/random"
      alt="Random image"
      height={500}
      width={500}
    />
  )
}

2. Using the Image component with the ImageProvider context component somewhere above the Image component in the component tree:

import Image, { ImageProvider } from '@wanner.work/image'

export default function MyComponent() {
  return (
    <ImageProvider
      loader={
        <div className="text-white absolute h-full w-full">Loading...</div>
      }
      cache={{
        enabled: true,
        maxAge: 1000 * 60 * 60 * 24,
        keyGenerator: (src) => src.split('?')[0] || src
      }}
    >
      <Image
        src="https://source.unsplash.com/random"
        alt="Random image"
        height={500}
        width={500}
      />
    </ImageProvider>
  )
}

Options

useImage hook

Input

  • src (string): The source of the image.
  • options? (useImageOptions?): Hook options:
    • cache? (ImageCacheOptions?): The cache options:
    • enabled? (boolean?): If the caching should be enabled
    • maxAge? (number?): The max age of the cache until the resources should be fetched again
    • keyGenerator? ((url: string) => string): If the key of the cache shouldn't just be the src url.

Output

  • isLoading (boolean): Boolean to show if the image is loading
  • image (string): Either the url or the base64 data url of the image.

Image component

  • src (string): The source of the image.
  • alt (string): The alt text of the image.
  • height? (number): The height of the image. Is required if fill is false.
  • width? (number): The width of the image. Is required if fill is false.
  • fill? (boolean): Whether the image should fill its container. Defaults to false.
  • loading? ('lazy' | 'eager'): The loading strategy of the image. Defaults to lazy.

ImageProvider component

  • loader? (ReactNode?): The loader to show while the image is loading. The custom node will be put into a container which has the exact width and height as the image will have.
  • cache? (ImageCacheOptions?): The cache options:
    • enabled? (boolean?): If the caching should be enabled
    • maxAge? (number?): The max age of the cache until the resources should be fetched again
    • keyGenerator? ((url: string) => string): If the key of the cache shouldn't just be the src url.

Further information

Next.js

The component can be used on Next.js and exposes the 'use client' directive as it uses useEffect, states and context.