react-image-follow

A React image component. The image follow with the mouse.

Usage no npm install needed!

<script type="module">
  import reactImageFollow from 'https://cdn.skypack.dev/react-image-follow';
</script>

README

🌈 react-image-follow

A React image component. The image follow with the mouse.

npm dumi codecov

📚 Example

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

🌀 Template

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

📦 Install

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

🎉 Usage

import Imagefollow from 'react-image-follow';
import 'react-image-follow/assets/index.css';

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

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

📔 API

Property Description Type Required Default Version
alt The alt of the image. string ✖ - 1.0.0
className Component extra class. string ✖ - 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
href Component click link string ✖ - 1.0.0

🔨 Development

yarn
yarn start

License

MIT