Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinussilvestrus/clickable-prototype
Lightweight React Library for creating clickable Prototypes
https://github.com/pinussilvestrus/clickable-prototype
prototype react react-components sketch ux
Last synced: about 2 months ago
JSON representation
Lightweight React Library for creating clickable Prototypes
- Host: GitHub
- URL: https://github.com/pinussilvestrus/clickable-prototype
- Owner: pinussilvestrus
- License: mit
- Created: 2019-12-17T17:25:40.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:33:45.000Z (almost 2 years ago)
- Last Synced: 2024-10-24T17:11:05.854Z (about 2 months ago)
- Topics: prototype, react, react-components, sketch, ux
- Language: JavaScript
- Homepage: https://clickable-prototype.netlify.com
- Size: 8.13 MB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# clickable-prototype
> Lightweight React Library for creating clickable Prototypes
[![NPM](https://img.shields.io/npm/v/clickable-prototype.svg)](https://www.npmjs.com/package/clickable-prototype) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) ![Build Status](https://github.com/pinussilvestrus/clickable-prototype/workflows/ci/badge.svg) ![npm bundle size](https://img.shields.io/bundlephobia/min/clickable-prototype)
[**Demo Page**](https://clickable-prototype.netlify.com/)
## Install
```bash
npm install --save clickable-prototype
```## Usage
```jsx
import React, { Component } from 'react'import { View, HitBox, ViewContainer } from 'clickable-prototype'
import view1 from './views/view1.png'
import view2 from './views/view2.png'export default class App extends Component {
render () {
return (
clickable-prototype Demo
)
}
}```
## Development Setup
To set up this project, first clone the repository
```bash
$ git clone https://github.com/pinussilvestrus/clickable prototype
```Change your working directory into the project directory
```bash
$ cd clickable-prototype
```Install all dependencies in the library and the [example](./example)
```bash
$ npm install
$ cd example && npm install
```Run the development server(s)
```bash
$ npm run dev
```## License
MIT © [pinussilvestrus](https://github.com/pinussilvestrus)