0.0.2 • Published 5 years ago

react-native-blobular v0.0.2

Weekly downloads
3
License
MIT
Repository
github
Last release
5 years ago

react-native-blobular

The Man in Blue's awesome Blobular, ported to React Native. Find the original experiment here!

🚀 Getting Started

Using npm:

npm install --save react-native-blobular

Using yarn:

yarn add react-native-blobular

This project depends on react-native-svg, so be sure that the library has been linked if you're running anything less than react-native@0.60.

✍️ Example

It's pretty simple, just embed a <Blobular /> inside your render method, then listen for the onBlobular callback, where you can allocate a number of Blobs for your user to play around with.

import React from 'react';
import { Dimensions } from 'react-native';
import uuidv4 from 'uuid/v4';

import Blobular, { Blob } from 'react-native-blobular';

const { width, height } = Dimensions
  .get('window');

export default () => (
  <Blobular
    onBlobular={({ putBlob }) => putBlob(
      new Blob(
        uuidv4(), // unique id
        100, // radius
        75, // viscosity
        50, // min radius
      ),
      width * 0.5,
      height * 0.5,
    )}
  />
);

You can also suppress user interaction by supplying pointerEvents="none" to your <Blobular /> component, and instead use the blobular instance returned in the callback to programmatically manipulate what's on screen.

📌 Props

PropertyTypeRequiredDescription
widthnumbernoWidth of the view.
heightnumbernoHeight of the view.
renderBlobfuncnoA function you can pass to define the SVG path.
pointerEventsstringnoAllow the user to interact, or manipulate programmatically.
onBlobularfuncnoA callback returning you with a blobular instance.
onBlobCreatedfuncnoA callback for when a new blob has been generated.
onBlobDeletedfuncnoA callback for when an existing blob has been removed.

✌️ License

MIT