Skip to content

πŸ’Ž A collection of lightweight React components and hooks to build diagrams with ease πŸ’Ž

License

Notifications You must be signed in to change notification settings

McIkenna/beautiful-react-diagrams

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Build Status License: MIT npm GitHub stars

beautiful-react-diagrams


A tiny collection of lightweight React components for building diagrams with ease

Diagrams banner

πŸ’‘ Why?

Javascript diagramming libraries are often quite difficult to integrate in React projects, given the different natures of the involved libraries. For example a React component's lifecylce may be quite hard to keep in in sync with a MVC diagramming library. For this reason we created beautiful-react-diagrams an easy-to-customise functional diagramming library built with React.

πŸŽ“ Principles

  • Controlled components: exports controlled components only.
  • Renderers: the majority of the exported components accept a renderer (a prop) to easily customise or extend their behaviour.
  • Lightweights: import nothing but lightweight javascript components.

β˜•οΈ Features

  • Concise API
  • Small and lightweight
  • Easy to use
  • Easy to customise

Contributing

Contributions are very welcome and wanted.

To submit your custom pull request, please make sure your read our CONTRIBUTING guidelines.

Before submitting a new pull request, please make sure:

  1. You have updated the package.json version and reported your changes into the CHANGELOG file
  2. make sure you run npm test and npm build before submitting your merge request.
  3. make sure you've added the documentation of your changes.
  4. if you've changed the signature of a component, please make sure you've updated the index.d.ts file.

Credits

This library is provided and sponsored by:

As part of our commitment to support and contribute to the open source community.


Icon made by Freepik from www.flaticon.com

About

πŸ’Ž A collection of lightweight React components and hooks to build diagrams with ease πŸ’Ž

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 89.7%
  • TypeScript 5.2%
  • SCSS 5.1%