use-dark v0.1.2

Use Dark

:warning: Experimental WIP :warning:

A canvas based hook for sliding images, inspired by Netflix's Dark opening theme.

Requisites

React 16.8+

Installation

npm install --save use-dark

Usage

With a single image

import React from 'react';
import useDark from 'use-dark';

import imgSrc from './dark.jpg';

function App() {
  const ref = useDark(imgSrc);
  return (
    <div>
      <canvas ref={ref} />
    </div>
  );
}

export default App;

With a series of images

import React, { useState, useEffect } from 'react';
import useDark from 'use-dark';

import img1Src from './dark1.jpg';
import img2Src from './dark2.jpg';

const images = [img1Src, img2Src];

function App() {
  const [index, setIndex] = useState(0);
  const ref = useDark(images[index]);

  useEffect(() => {
    const i = setInterval(() => {
      setIndex((c) => (c < images.length - 1 ? c + 1 : 0));
    }, 5000);
    return () => clearInterval(i);
  }, []);

  return (
    <div>
      <canvas ref={ref} />
    </div>
  );
}

export default App;

With configurable options and React Spring

import React, { useState, useEffect, useCallback } from 'react';
import { useSpring, animated } from 'react-spring';
import useDark from 'use-dark';

import img1Src from './dark1.jpg';

const slides = [
  {
    dark: {
      image: img1Src,
      type: 3,
      speed: 0.3,
      responsive: [
        [600, 1],
        [800, 2],
      ],
    },
    data: {
      text: 'USE DARK',
      subtext: (
        <span>
          canvas based <strong>react hook</strong>
        </span>
      ),
    },
  },
  {
    dark: {
      image: 'https://external.url/image.jpg',
      type: 4,
      speed: 0.4,
      responsive: [
        [600, 1],
        [800, 3],
      ],
    },
    data: {
      text: 'INSTALL',
      subtext: (
        <span>
          npm install <strong>use-dark</strong>
        </span>
      ),
    },
  },
];

function App() {
  const [slide, setSlide] = useState({
    index: 0,
    data: {},
    dark: slides[0].dark,
  });
  const [fading, setFading] = useState(true);
  const props = useSpring({ opacity: fading ? 0 : 1 });

  const onFadeOut = useCallback(() => {
    setFading(true);
  }, []);

  const onFadeIn = useCallback(() => {
    setFading(false);
    setSlide((prev) => ({ ...prev, data: slides[prev.index].data }));
    setTimeout(() => {
      setSlide((prev) => {
        const index = prev.index < slides.length - 1 ? prev.index + 1 : 0;
        return {
          ...prev,
          index,
          dark: slides[index].dark,
        };
      });
    }, 5000);
  }, []);

  const { data, dark } = slide;

  const ref = useDark(dark, onFadeIn, onFadeOut);

  return (
    <div>
      <canvas ref={ref} />
      <animated.div style={props}>
        <h1>{data.text}</h1>
        <h2>{data.subtext}</h2>
      </animated.div>
    </div>
  );
}

export default App;

Changelog

0.1.2

• responsive option: it supports a list of integers couples with the form of breakpoint, type
• onFadeIn / onFadeOut callbacks revised: it enables a better synchronization with external animation or music

0.1.1

• initial release

License

MIT