Giter Club home page Giter Club logo

remage's Introduction

Remage

A modular toolkit to make static images interactive in react.

Open Source Love svg2

It supports:

  • Cross platform support for zooming and panning (thanks to react-zoom-pan-pinch)
  • Fully customizable interactables that scale and move with the base image
  • Reusable interactable components, with more advanced interactables coming soon!
  • Freedom to Mix & Match any combination of interactables
  • Built-in keyword based search
  • Typescript support

Quickstart

Remage is going to be launched as an npm package soon!

Import the remage components, and use the following props to configure it:

  1. src: This is a path to the base image
  2. title: Optional, Displayed above the remage and in the search bar
  3. interactables: An Array of interactable objects with the following type:
type Interactable = {
  top: number,
  left: number,
  interactable: (state: {scale: number, positionX: number, positionY: number}) => React.ReactNode
}

Sample Usage

More examples can be found on the remage webpage

<Remage
   src="base-img.png"
   title="Seven Wonders"
   interactables={[
      {
         top: "20%",
         left: "31.4%",
         interactable: () => {
            return <div>x</div>
         }
      }
   ]}
/>

Authors

Soham Kulkarni

Suyash Nagumalli

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.