Skip to content

image-component/react-image-dangling

Repository files navigation

🌈 react-image-dangling

A React image component. Dangling interaction effect.

npm dumi codecov

πŸ“š Example

Online: https://image-component.github.io/react-image-dangling/

πŸŒ€ Template

https://github.com/one-template/react-component-template

πŸ“¦ Install

npm i react-image-dangling
# or
yarn add react-image-dangling

πŸŽ‰ Usage

import ImageDangling from 'react-image-dangling';
import 'react-image-dangling/assets/index.css';

const src =
  'https://github.com/image-component/gallery/blob/main/girl/1.jpg?raw=true';

export default () => (
  <>
    <ImageDangling src={src} />
  </>
);

πŸ“” API

Property Description Type Required Default Version
alt The alt of the image. string βœ– - 1.0.0
blendMode Whether to enable mix-blend-mode.
When set true, the default is soft-light. More see mix-blend-mode.
boolean | string βœ– false 1.0.0
className Component extra class. string βœ– - 1.0.0
hoverScale The hover scale of the image. Require >= 1 && <=5. number βœ– 1.6 1.0.0
hoverSlope The hover slope of the image. Require >= 10 && <=90. number βœ– 60 1.0.0
shadeColor To set the mixed background color when use blendMode. string βœ– #000 1.0.0
radius The border radius of the component. number βœ– 8 1.0.0
src The src of the image. string βœ” - 1.0.0
style Component extra style. CSSProperties βœ– - 1.0.0
width The width of the image. number βœ– 300 1.0.0

πŸ”¨ Development

yarn
yarn start

License

MIT