Skip to main content

Installation

Prerequisites​

React​

This documentation assumes you are already familiar with React and have a project setup. If it is not the case, you should read React's Getting Started documentation first.

Sigma​

This documentation assumes you are already familiar with Sigma. It is not a replacement for Sigma's documentation.

Peer dependencies​

Sigma and graphology are required peer dependencies. If you are using typescript, graphology-types is also required.

With NPM​

With npm, you can install React Sigma with its peer dependencies by executing :

npm install @react-sigma/core sigma graphology graphology-types

With yarn​

Yarn automatically installs peer dependencies, so you can install React Sigma with :

yarn add @react-sigma/core

Typescript​

React Sigma is written in Typescript, so types definition are natively provided by the library.