docs

SisenseJS React - Documentation

Table of contents

• Getting started
• API Reference
• Examples

---

Getting Started

Step 1: Prepare your environment

• You will need access to the Sisense instance containing the widgets you wish to embed, as well as access to the dashboards containing these widgets.
• Make sure you can log into the Sisense instance directly (with CSRF protection disabled) or via SSO
• Make sure the instance has CORS set up correctly to allow your application; You may also need to set up SSL.
• Make sure the instance is accssible to your application via HTTPS

Step 2: Include the package in your project

This is a monorepo, containing several packages as well as sample projects.

The various npm packages contained within, are deployed via Github Packages. Follow these steps to install them:

Step 2A - Adding the namespace to your project

For npm and Yarn classic:

npm config set "@mr-yum:registry" "https://npm.pkg.github.com" --userconfig .npmrc

For Yarn 2+:

yarn config set "npmScopes.sisense.npmRegistryServer" "https://npm.pkg.github.com"

Step 2B - Adding Github packages authentication

Create a personal access token with the read:packages permission. Then, configurate your package manager to use the token to authenticate to Github packages. Replace __YOUR_TOKEN__ with your access token below:

For npm and Yarn classic:

npm config set "always-auth" true --userconfig .npmrc
npm config set "//npm.pkg.github.com/:_authToken" "__YOUR_TOKEN__" --userconfig .npmrc

For Yarn 2+:

yarn config set "npmScopes.sisense.npmAlwaysAuth" true
yarn config set "npmScopes.sisense.npmAuthIdent" "__YOUR_GITHUB_USERNAME__:__YOUR_TOKEN__"

For more information, please refer to Github Packages documentation

Step 2C - Installing the package

npm:

npm install @mr-yum/sjs-react --save

Yarn:

yarn add @mr-yum/sjs-react

Step 3: Import the package into your code

Import all or some of the types the package includes, for example:

// Import the components you need
import { SisenseApp, SisenseDashboard, SisenseWidget } from "@mr-yum/sjs-react";

Step 4: Embed using components

You will need:

• The full URL of your Sisense instance
• The oid of any dashboards containing widgets to embed
• The oid of each widget to embed

Example:

function App() {
  return (
    <SisenseApp url="https://myinstance.example.com">
      <SisenseDashboard oid="{dashboard_id}">
          <SisenseWidget oid="{widget_id_1}" />
          <SisenseWidget oid="{widget_id_2}" />
      </SisenseDashboard>
    </SisenseApp>
  );
}

export default App;

---

API Reference

API references can be found under docs/components for each of these components:

Component	Documentation
SisenseApp	docs/components/sisense-app/readme.md
SisenseDashboard	docs/components/sisense-dashboard/readme.md
SisenseWidget	docs/components/sisense-widget/readme.md
SisenseFilters	docs/components/sisense-filters/readme.md

Since this library has been built with Typescript, you should be able to easily explore the properties and methods exposed by each of these components. Additional documentation will be added over time.

---

Examples

You'll find sample projects within the /examples directory.