https://github.com/fdaciuk/react-trianglify

React Wrapper Component for trianglify
https://github.com/fdaciuk/react-trianglify

hacktoberfest

Last synced: 18 days ago
JSON representation

React Wrapper Component for trianglify

• Host: GitHub
• URL: https://github.com/fdaciuk/react-trianglify
• Owner: fdaciuk
• License: gpl-3.0
• Created: 2016-11-15T20:45:39.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-05-20T23:19:08.000Z (6 months ago)
• Last Synced: 2024-10-17T19:39:36.503Z (27 days ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/react-trianglify
• Size: 3.64 MB
• Stars: 39
• Watchers: 3
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# React Trianglify

> React Wrapper Component for [trianglify][trianglify-url]

:us: [English][en-docs] | :brazil: [Português do Brasil][pt-br-docs]

## Installation

**Using Bun:**

```sh

bun add react-trianglify trianglify

# If you're using TypeScript, add these types as `devDependencies`:

bun add --dev @types/trianglify

```

**Using NPM:**

```sh

npm install --save react-trianglify trianglify

# If you're using TypeScript, add these types as `devDependencies`:

npm install --save-dev @types/trianglify

```

**Using Yarn:**

```sh

yarn add react-trianglify trianglify

# If you're using TypeScript, add these types as `devDependencies`:

yarn add --dev @types/trianglify

```

## Dependencies

You must have `react` and `trianglify` already installed on your project.

PS.: If you have any problems with latest trianglify version, try to install the tested version `v4.1.1`.

## Usage

```js

import Trianglify from 'react-trianglify'

ReactDOM.render(, $mountNode)

```

## Props

By taking `output`, you can use any [trianglify][trianglify-url-options] allowed options.

Possible `output` values:

- `canvas` (default)

- `svg`

## Live demo

You can access `react-trianglify` live demo [here][demo-url]

## License

[GPL-3.0][license-url] © Fernando Daciuk

[trianglify-url]: https://github.com/qrohlf/trianglify

[trianglify-url-options]: https://github.com/qrohlf/trianglify#-configuration

[demo-url]: https://react-trianglify.vercel.app/

[license-url]: /LICENSE

[en-docs]: /README.md

[pt-br-docs]: /docs/pt-br.md