https://github.com/davebitter/motion-workshop

Quick kick-starter for the Motion Workshop
https://github.com/davebitter/motion-workshop

create-react-app netlify react react-hooks react-spring reactjs

Last synced: 8 days ago
JSON representation

Quick kick-starter for the Motion Workshop

• Host: GitHub
• URL: https://github.com/davebitter/motion-workshop
• Owner: DaveBitter
• Created: 2020-05-11T07:25:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-10T22:24:17.000Z (over 2 years ago)
• Last Synced: 2024-10-15T15:14:31.534Z (23 days ago)
• Topics: create-react-app, netlify, react, react-hooks, react-spring, reactjs
• Language: CSS
• Size: 3.05 MB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Motion Workshop

[![Netlify Status](https://api.netlify.com/api/v1/badges/4fc26494-05ab-41d2-9518-037b89c7182f/deploy-status)](https://app.netlify.com/sites/motion-workshop/deploys)

![hero image](docs/hero.jpg)

This repository holds the code for the interactive coding part of the Motion Workshop with [React Spring](https://www.react-spring.io/). Read the documentation to get the app up and running. Next to that, some things are setup for you to start animating!

Motion Workshop was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). You can find the demo [here](http://motion-workshop.netlify.app/)

## Getting started

First **FORK** this repository.

In the project directory, you can run:

### `yarn start` or `yarn dev`

Runs the app in the development mode.


Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.


You will also see any lint errors in the console.

### `yarn build`

Builds the app for production to the `build` folder.


It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.


Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

## Available Utilities/Components

### `getAnimationConfiguration`

Although React Spring offers a simple API, some things might be a bit confusing. In [`src/utils/getAnimationConfiguration.js`](src/utils/getAnimationConfiguration.js) you can find a utilites that simplifies the configuration.

This utility can receive a couple of parameters:

```JS

import { config } from 'react-spring'

...

{

    from: { transform: 'translate3d(0, 0.5rem, 0)', opacity: 0 },

    to: { transform: 'translate3d(0, 0rem, 0)', opacity: 1 },

    physics: { ...config.wobbly, tension: 170 }, // basic React Spring configuration extended

    delay: 200,

    isActive: true

}

```

* **from `Object`:**  CSS properties to animate from

* **to `Object`:**  CSS properties to animate to

* **isActive `Boolean`:**  Whether to flip the animation

* **physics `Object`:**  React spring physics configuration object. Please refer to [React spring Common API documentation](https://www.react-spring.io/docs/hooks/api) for possibilities

* **delay `Number`:**  Delay in animation to account for Carousel in and out timing

### `carouselItems`

Data for the carousel is already setup for you. Please feel free to make this your own in [`src/data/carouselItems.json`](src/data/carouselItems.json)

### `Carousel`

You can find all of the code for the `Carousel` in [`src/components/Carousel/Carousel.js`](src/components/Carousel/Carousel.js). As you can see, in `CarouselItem` (located in the same file) you can configure the animations using the `getAnimationConfiguration` utility.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).