8000 GitHub - jaredatron/react-shimmer: 🌠 Async loading, performant Image component for React.js
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

jaredatron/react-shimmer

 
 

Repository files navigation

Logo

A powerful, customisable, Suspense-like <img> component that (optionally) simulates a shimmer effect while loading. (with zero dependencies!).

NPM JavaScript Style Guide Github Actions CI Status Maintainability

Header

Install

npm i react-shimmer

or

yarn add react-shimmer

Usage

import React from 'react'
import Image, { Shimmer } from 'react-shimmer'

function App() {
  return (
    <div>
      <Image
        src='https://source.unsplash.com/random/800x600'
        fallback={<Shimmer width={800} height={600} />}
      />
    </div>
  )
}

or you can use your custom React component as a fallback:

import React from 'react'
import Image from 'react-shimmer'

import Spinner from './Spinner'

function App(props) {
  return (
    <div>
      <Image
        src="https://example.com/test.jpg"
        fallback={<Spinner />}
      />
    </div>
  )
}

Properties

Property Type Required Default value Description
src string yes
fallback ReactNode yes
errorFallback func no
onLoad func no
delay number no Delay in milliseconds before showing the fallback
NativeImgProps React.ImgHTMLAttributes no

Contributing


Feel free to send PRs.

License

MIT © gokcan

About

🌠 Async loading, performant Image component for React.js

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 72.8%
  • JavaScript 13.4%
  • CSS 7.9%
  • HTML 5.9%
0