Giter VIP home page Giter VIP logo

creepyface's Introduction

Creepyface ยท GitHub license npm version Build Coverage Status Follow on Twitter

Creepyface is a little JavaScript library that makes your face look at the pointer (or dance!).

See it in action at creepyface.io and create your own one using the wizard.

If you use React, check out <Creepyface />. If you like fireflies, check out creepyface-firefly.

Example animated gif of a face looking at the pointer

Creepyface in the wild:

Usage

<script src="https://creepyface.io/creepyface.js"></script>

<img
  data-creepyface
  src="https://creepyface.io/img/0/serious"
  data-src-hover="https://creepyface.io/img/0/hover"
  data-src-look-0="https://creepyface.io/img/0/0"
  data-src-look-45="https://creepyface.io/img/0/45"
  data-src-look-90="https://creepyface.io/img/0/90"
  data-src-look-135="https://creepyface.io/img/0/135"
  data-src-look-180="https://creepyface.io/img/0/180"
  data-src-look-225="https://creepyface.io/img/0/225"
  data-src-look-270="https://creepyface.io/img/0/270"
  data-src-look-315="https://creepyface.io/img/0/315"
/>

Run this example on codepen.

Creepyface will automatically detect your image (thanks to the data-creepyface attribute) and make it look at the mouse or fingers depending on which device you are using.

You can add as many Creepyfaces as you want as long as they all have the data-creepyface attribute.

If you want to stop Creepyface on a given image:

creepyface.cancel(document.querySelector('img'))

Full list of data attributes

Name Description
data-creepyface Add this to automatically attach creepyface to your image when the page loads.
data-src-hover The URL of the image to use when the pointer is over your image.
data-src-look-<angle> The URL of the image to use when the pointer forms the specified angle (in degrees) with the center of your image. Add as many as you want.
data-timetodefault The amount of time (in milliseconds) after which the default src is restored if no pointer events are received. 1 second by default. 0 means it will never be restored (the image will always look at the pointer).
data-throttle The amount of time (in milliseconds) to wait between src changes. 100 by default.
data-fieldofvision The angle (in degrees) inside which the pointer will be detected by a given direction. 150 by default.
data-points Optionally, a comma-separated list of point provider names to make your face look at things other than the pointer. See Super advanced usage for more information.

Advanced usage

For more advanced use cases Creepyface can also be set up via a programmatic API:

<img src="https://creepyface.io/img/0/serious" />
import creepyface from 'creepyface'

const img = document.querySelector('img')

const cancel = creepyface(img, {
  // Time (in ms) to wait between src updates
  throttle: 100,
  // Image URL to display on hover
  hover: 'https://creepyface.io/img/0/hover',
  // Each of the images looking at a given direction
  looks: [
    { angle: 0, src: 'https://creepyface.io/img/0/0' },
    { angle: 45, src: 'https://creepyface.io/img/0/45' },
    { angle: 90, src: 'https://creepyface.io/img/0/90' },
    { angle: 135, src: 'https://creepyface.io/img/0/135' },
    { angle: 180, src: 'https://creepyface.io/img/0/180' },
    { angle: 225, src: 'https://creepyface.io/img/0/225' },
    { angle: 270, src: 'https://creepyface.io/img/0/270' },
    { angle: 315, src: 'https://creepyface.io/img/0/315' }
  ],
  // Time (in ms) to restore the default image after the last input
  timeToDefault: 1000
  // The angle (in degrees) inside which the pointer will be detected
  fieldOfVision: 150
})

// at some point restore the original image and stop creepyface
cancel()

Run this example on codepen.

Super advanced usage

Creepyface will look at the pointer by default, however custom point providers can be defined.

For example, to make your face look at a random point every half a second you need to register a point provider:

import creepyface from 'creepyface'

creepyface.registerPointProvider('random', (consumer, img) => {
  const interval = setInterval(
    () =>
      consumer([
        Math.random() * window.innerWidth,
        Math.random() * window.innerHeight
      ]),
    500
  )
  return () => {
    clearInterval(interval)
  }
})

and consume it using the data-points attribute:

<img
  data-creepyface
  data-points="random"
  src="https://creepyface.io/img/0/serious"
  data-src-hover="https://creepyface.io/img/0/hover"
  data-src-look-0="https://creepyface.io/img/0/0"
  data-src-look-45="https://creepyface.io/img/0/45"
  data-src-look-90="https://creepyface.io/img/0/90"
  data-src-look-135="https://creepyface.io/img/0/135"
  data-src-look-180="https://creepyface.io/img/0/180"
  data-src-look-225="https://creepyface.io/img/0/225"
  data-src-look-270="https://creepyface.io/img/0/270"
  data-src-look-315="https://creepyface.io/img/0/315"
/>

Run this example on codepen.

or pass it programmatically:

<img src="https://creepyface.io/img/0/serious" />
const img = document.querySelector('img')

creepyface(img, {
  points: (consumer, img) => {
    const interval = setInterval(
      () =>
        consumer([
          Math.random() * window.innerWidth,
          Math.random() * window.innerHeight
        ]),
      500
    )
    return () => {
      clearInterval(interval)
    }
  },
  hover: 'https://creepyface.io/img/0/hover',
  looks: [
    { angle: 0, src: 'https://creepyface.io/img/0/0' },
    { angle: 45, src: 'https://creepyface.io/img/0/45' },
    { angle: 90, src: 'https://creepyface.io/img/0/90' },
    { angle: 135, src: 'https://creepyface.io/img/0/135' },
    { angle: 180, src: 'https://creepyface.io/img/0/180' },
    { angle: 225, src: 'https://creepyface.io/img/0/225' },
    { angle: 270, src: 'https://creepyface.io/img/0/270' },
    { angle: 315, src: 'https://creepyface.io/img/0/315' }
  ]
})

Note: several point providers can work at the same time by using a comma-separated string like "random,pointer".

The following point providers are available out of the box:

  • pointer for both mouse and touch events. This is the default.
  • mouse just for mouse events.
  • finger just for touch events.

There are also external point providers:

  • ๐ŸŽถ dance to dance to the rythm of the music.
  • ๐Ÿคณ tilt to stare at you when you tilt your phone.
  • ๐Ÿ firefly to follow a moving firefly on the screen.

Developing

  • yarn && yarn build will set up the packages (using workspaces and Lerna) and run a required initial build.
  • yarn start will spin up local servers for each of the packages.
  • yarn test will run the tests.

Contributing

Please feel free to create issues and / or submit pull requests. For the latter, test cases are very welcome.

License

MIT, see LICENSE for details.

Big Thanks

Cross-browser Testing Platform and Open Source โค๏ธ provided by Sauce Labs.

creepyface's People

Contributors

4lejandrito avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.