https://github.com/MausTec/react-buttplug

https://github.com/MausTec/react-buttplug

Last synced: about 4 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/MausTec/react-buttplug
• Owner: MausTec
• Created: 2021-02-08T01:25:24.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-02-19T03:19:52.000Z (over 3 years ago)
• Last Synced: 2024-05-07T04:03:04.502Z (about 2 months ago)
• Language: JavaScript
• Size: 3.69 MB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Lists

• awesome-buttplug - react-buttplug

README

        
# react-buttplug

> React provider for Buttplug.io's `buttplug-ffi-js` library. Here there be WASM.

[![NPM](https://img.shields.io/npm/v/@maustec/react-buttplug.svg)](https://www.npmjs.com/package/@maustec/react-buttplug) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash

npm install --save @maustec/react-buttplug

```

Since `buttplug` requires a WASM blob, you'll need to tell webpack that WASM files are `webassembly/experimental` typed..

If you're using `create-react-app`, check out `CRACO`:

`https://github.com/gsoft-inc/craco`

Your new rule should look something like this:

```js

{

    test: /\.wasm$/,

    type: 'webassembly/experimental'

}

```

Check out `example/` for a create-react-app setup that initializes Buttplug.

## Usage

Wrap your app in this and you'll be able to consume `ButtplugContext` wherever

you need control of buttplugs. Any methods of interest are available on the

context.

### First, provide your App.

```jsx

import { ButtplugProvider } from '@maustec/react-buttplug'

import {

  VibratorSearchButton,

  VibratorControls

} from 'the-next-examples'

const App = () => {

  return (

    

      

      

    

  )

}

```

### Then consume the context to create, for example, a connect button:

```jsx

import React, { useContext } from 'react'

import { ButtplugDeviceContext } from '@maustec/react-buttplug'

const VibratorSearchButton = () => {

  const { buttplugReady, startSearching } = useContext(ButtplugDeviceContext);

  const handleClick = (e) => {

    e.preventDefault();

    startSearching()

      .then(console.log)

      .catch(console.error)

   }

  if (buttplugReady) {

    return (

      Start Searching

    )

  } else {

    return (

      
Waiting for Buttplugs...

    )

  }

}

```


### Finally, you can do things with the devices here:

```jsx

import React, { useContext, useState } from 'react'

import {

  ButtplugDeviceContext,

  ButtplugDeviceController

} from '@maustec/react-buttplug'

const VibratorControls = () => {

  const { devices } = useContext(ButtplugDeviceContext)

  const [ vibrateSpeed, setVibrateSpeed ] = useState(0.0);

  const handleVibrateChange = (e) => {

    setVibrateSpeed(parseFloat(e.target.value))

  }

  return (

    


      


      


        { devices.map((device) => (

          

            
{ device.Name }

          

        )) }

      

    

  )

}

```


## TODO

- Find a way to indicate a pending device pairing, e.g. after clicking "Pair" and before `deviceadded` fires.

## License

MIT © [MausTec](https://github.com/MausTec)