1.0.0 • Published 12 months ago

react-stacked-photos v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

React Stacked Photos

React Stacked Photos is a very light React component that harnesses the power of CSS to create a stacked photo/carousel experience. React Stacked Photos does its thing and leaves the way for you to make your magic.

Demo

stackedcarousel

Check out the demo here and play around with some samples.

Installation

If you're using npm, in the command prompt run:

npm install react-stack-photos --save

If you're using yarn, run:

yarn add react-stack-photos

Usage

To use the component, first import ReactStackedPhotos into your file:

import ReactStackedPhotos from "react-stack-photos";

Then wrap the <ReactStackedPhotos> tags around any components - it must be a React Element - you'd like to see the effect on.

By default, the width and height of the ReactStackedPhotos will be zero, 0, so set the width and height on the parent ReactStackedPhotos

<ReactStackedPhotos width={200} height={200}>
  <div>1</div>
  <div>2</div>
  <div>3</div>
</ReactStackedPhotos>

stackedphotos1

Add styles to your children components as you wish

<ReactStackedPhotos width={200} height={200}>
  <div style={{ fontSize: "7rem" }}>1</div>
  <div style={{ fontSize: "7rem" }}>2</div>
  <div style={{ fontSize: "7rem" }}>3</div>
</ReactStackedPhotos>

stackedphotos2

Since we would most likely be using ReactStackedPhotos with images, let's replace its children with some images. The images used here are some random images on the web. Feel free to replace it with yours.

<ReactStackedPhotos width={200} height={200}>
  <div>
    <img
      src="https://inspirationseek.com/wp-content/uploads/2016/02/Cute-Dog-Photo.jpg"
      alt=""
      style={{ width: "100%", height: "100%", objectFit: "cover" }}
    />
  </div>

  <div>
    <img
      src="https://th.bing.com/th/id/R.fbb965fdc665d0bd4f8da283797a01a8?rik=lIO7W69%2flMx8MQ&riu=http%3a%2f%2f3.bp.blogspot.com%2f_fU7LdRkUMVM%2fTJTouRK_dTI%2fAAAAAAAAChM%2fO08EDbQJTwA%2fs1600%2fcute-baby-dog.jpeg&ehk=3ComR3Gf7XCD8wEKZXLMBPSkzlgxYZ7790TXto%2bJj3A%3d&risl=&pid=ImgRaw&r=0"
      alt=""
      style={{ width: "100%", height: "100%", objectFit: "cover" }}
    />
  </div>
  <div>
    <img
      src="https://th.bing.com/th/id/R.8b7fad01da5367c68c467bd6948670fd?rik=KFSmp6damF3c3Q&riu=http%3a%2f%2f4.bp.blogspot.com%2f-GOOCS9LbwP8%2fTaz7HOWknfI%2fAAAAAAAAACs%2fV7sR0wpvMKM%2fs1600%2fCute%2bPuppy%2bDog.jpg&ehk=c2CdJK42k3Sc83ZNT7zEIYYZmfyLA15lZDuWBu7FdUM%3d&risl=&pid=ImgRaw&r=0"
      alt=""
      style={{ width: "100%", height: "100%", objectFit: "cover" }}
    />
  </div>
</ReactStackedPhotos>

stackedphotos3

It is important to know that all ReactStackedPhotos child must be a div. We wrapped our images in a div.

I went on to add some styles to my children component to cause those slant rotate effect that I want.

Style yours to your fit.

  <div>
    <img
      src="https://inspirationseek.com/wp-content/uploads/2016/02/Cute-Dog-Photo.jpg"
      alt=""
      style={{ width: "100%", height: "100%", objectFit: "cover" }}
    />
  </div>

  <div style={{ transform: "rotate(4deg)" }}>
    <img
      src="https://th.bing.com/th/id/R.fbb965fdc665d0bd4f8da283797a01a8?rik=lIO7W69%2flMx8MQ&riu=http%3a%2f%2f3.bp.blogspot.com%2f_fU7LdRkUMVM%2fTJTouRK_dTI%2fAAAAAAAAChM%2fO08EDbQJTwA%2fs1600%2fcute-baby-dog.jpeg&ehk=3ComR3Gf7XCD8wEKZXLMBPSkzlgxYZ7790TXto%2bJj3A%3d&risl=&pid=ImgRaw&r=0"
      alt=""
      style={{ width: "100%", height: "100%", objectFit: "cover" }}
    />
  </div>
  <div style={{ transform: "rotate(-10deg)" }}>
    <img
      src="https://th.bing.com/th/id/R.8b7fad01da5367c68c467bd6948670fd?rik=KFSmp6damF3c3Q&riu=http%3a%2f%2f4.bp.blogspot.com%2f-GOOCS9LbwP8%2fTaz7HOWknfI%2fAAAAAAAAACs%2fV7sR0wpvMKM%2fs1600%2fCute%2bPuppy%2bDog.jpg&ehk=c2CdJK42k3Sc83ZNT7zEIYYZmfyLA15lZDuWBu7FdUM%3d&risl=&pid=ImgRaw&r=0"
      alt=""
      style={{ width: "100%", height: "100%", objectFit: "cover" }}
    />
  </div>

Also I want an hover effect. This is optional. But is something you will love.

To add an hover style to your children components, simply add the styles to a isHoveringStyles component.

  <div>
    ...
  </div>
  <div
    style={{ transform: "rotate(4deg)" }}
    data-ishovering={{ transform: "rotate(2deg) translateX(30px)" }}
  >
    ...
  </div>
  <div
    style={{ transform: "rotate(-10deg)" }}
   data-ishovering={{ transform: "rotate(-5deg) translateX(-30px)" }}
  >
    ...
  </div>

stackedphotos4

There you have it. Super simple and stressfree.

A sample file might look like this:

import React from "react";
import MyComponent from "../components/MyComponent";
import ReactStackedCarousel from "react-stacked-photos";

const App = () => (
  <ReactStackedCarousel width={100} height={100}>
    <MyComponent />
    <MyComponent />
    <MyComponent />
  </ReactStackedCarousel>
);

export default App;

Props

PropertyTypeDefaultDescription
widthnumber in px{}Used to set the width of parent of the photos or children components
heightnumber in px""Used to set the width of parent of the photos or children component
data-ishoveringcssStyles{}used to add hover effect on each child of the ReactStackedPhotos. Apply it to each child of the ReactStackedPhotos
1.0.0

12 months ago

0.0.6

12 months ago

0.0.5

12 months ago

0.0.4

12 months ago

0.0.3

12 months ago

0.0.2

12 months ago