https://github.com/dechristopher/react-octadground

https://github.com/dechristopher/react-octadground

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/dechristopher/react-octadground
• Owner: dechristopher
• License: agpl-3.0
• Created: 2021-03-15T22:18:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-22T01:32:38.000Z (over 3 years ago)
• Last Synced: 2025-05-07T04:46:14.974Z (about 1 year ago)
• Language: JavaScript
• Size: 28.1 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# React Octadground

[![NPM Download Stats](https://nodei.co/npm/react-octadground.png?downloads=true)](https://www.npmjs.com/package/react-octadground)

[![Dependency Status](https://david-dm.org/dechristopher/react-octadground.svg)](https://david-dm.org/dechristopher/react-octadground)

[![devDependencies Status](https://david-dm.org/dechristopher/react-octadground/dev-status.svg)](https://david-dm.org/dechristopher/react-octadground?type=dev)

[![Known Vulnerabilities](https://snyk.io/test/github/dechristopher/react-octadground/badge.svg?targetFile=package.json)](https://snyk.io/test/github/dechristopher/react-octadground?targetFile=package.json)

**react-octadground** is a React wrapper of [Octadground](https://github.com/dechristopher/octadground)

## Installation

```

npm install --save react-octadground

```

## Example

- An example implementation with free move is provided in [example](https://github.com/dechristopher/react-octadground/tree/master/example)

## Usage

```js

import Octadground from 'react-octadground'

import 'react-octadground/dist/styles/octadground.css'

const Demo: FC = props => {

  return ;

}

```

## Documentation

Options of `Octadground` are mapped to properties of `react-octadground`

You can refer to documentation of `Octadground` for detailed configuration

- [Config documented types](https://github.com/dechristopher/octadground/tree/master/src/config.ts)

- [Config default values](https://github.com/dechristopher/octadground/tree/master/src/state.ts)