react-arte

Install

npm install --save react-arte

Usage

import * as React from 'react'

import { Page, Scene, SceneTimeline, SceneView } from 'react-arte'

class ComponentA extends React.Component {
  render() {
    return (
      <SceneTimeline>
        <SceneView>
          Custom component A
        </SceneView>
      </SceneTimeline>
    )
  }
}

class ComponentB extends React.Component {
  render() {
    return (
      <SceneTimeline parallax>
        <SceneView>
          Custom component B
        </SceneView>
      </SceneTimeline>
    )
  }
}

class ComponentC extends React.Component {
  render() {
    return (
      <SceneTimeline>
        <SceneView>
          Custom component C
        </SceneView>
      </SceneTimeline>
    )
  }
}

class Example extends React.Component {
  render () {
    return (
      <Page>
        <Scene>
          <ComponentA />
        </Scene>
        <Scene>
          <ComponentB />
        </Scene>
        <Scene>
          <ComponentC />
        </Scene>
      </Page>
    )
  }
}

Component Hooks

  /**
   * Scene enters the viewport
   */
  onScreenEnter() {
    
  }

  /**
   * Scene entering the viewport progress
   */
  onScreenEnterProgress(event: ScrollerEvent) {

  }

  /**
   * Scene completly in the viewport
   */
  onSceneEnter(event: ScrollerEvent) {
    
  }

  /**
   * Scene start scrolling
   */
  onSceneStart(event: ScrollerEvent) {
    
  }

  /**
   * Scene scroll progress
   */
  onSceneProgress(event: ScrollerEvent) {
    
  }

  /**
   * Scene leaving
   */
  onSceneLeave(event: ScrollerEvent) {
    
  }

  /**
   * Scene leaving the viewport progress
   */
  onScreenLeaveProgress(event: ScrollerEvent) {
    
  }

  /**
   * Scene leave the viewport
   */
  onScreenLeave() {
    
  }

License

MIT © artus.com