Skip to content

noahehall/react-idealer-image

This branch is 15 commits ahead of stereobooster/react-ideal-image:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5571564 · Jun 10, 2023
Jun 10, 2023
Jun 3, 2023
May 20, 2023
Jun 10, 2023
May 20, 2018
Jun 10, 2023
Jun 3, 2023
Jun 3, 2023
Jun 10, 2023
May 20, 2023
Jun 10, 2023
Jun 10, 2023
Jun 10, 2023
Jun 10, 2023
Jun 3, 2023
Jun 3, 2023

Repository files navigation

react-idealer-image

  • shoutouts to the original authors and contributors
  • please see the original repository for extended readme and documentation
  • the goal of this fork should be to merge into the original repo

TLDR

  • uses the bun runtime and is a complete refactor
  • typescript first, esm only, no support for legacy browsers
  • framer-motion replaces react-waypoint
bun add \
  github:noahehall/react-idealer-image \
  framer-motion \
  react \
  react-dom
import { IdealImage } from "react-idealer-image";

const App = () => (
  /** check the component source for the full api */
  <IdealImage
    /* see framer-motion docs */
    /* motionProps={} */
    alt="ideal image"
    // you could include specific width & height set to numbers
    srcSet={[{ src: "some/image.webp" }]}
    // prefer passing width && height set to numbers
    width={"100%"}
  />
);

Contributing

# clone repo
bun install
bun run cosmos
# open localhost:5000
# set network throttling to something really slow

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.4%
  • JavaScript 4.6%