Skip to main content

Installing Reveal SDK Web Component Wrappers in React

Product in Beta

The Reveal SDK Web Component Wrappers are currently under development, and we welcome your feedback to help us improve for the final release.

The documentation for the Wrappers are under construciton, but we didn't want to wait until they were done before sharing.

The Reveal SDK Web Component Wrappers provides a React-friendly version of each component, ensuring an idiomatic experience for React developers. You can easily switch between HTML and React examples throughout the documentation.

Installation​

To add the Reveal SDK Web Component Wrappers to your React app, install the necessary packages from npm:

npm install reveal-sdk-wrappers reveal-sdk-wrappers-react

Using Reveal SDK Web Components​

Once everything is set up, you're ready to use the Reveal SDK Web Component Wrappers within your React application. Here's an example of integrating the RvRevealView component:

import React from 'react';
import { RvRevealView } from 'reveal-sdk-wrappers-react';

function App() {
  return (
    <div>
      <RvRevealView dashboard="Sales"></RvRevealView>
    </div>
  );
}

export default App;

With these steps, you've successfully integrated the Reveal SDK Web Component Wrappers into your React application. You can now leverage Reveal's powerful data visualization capabilities to enhance your projects. Explore more components and features to create a rich and interactive user experience.