@cue-ai/embedded

@cue-ai/embedded

Charts provide out-of-the-box visualizations for your data that are fully compatible with the Cue AI platform.

Installation

yarn add @cue-ai/embedded

Release Channels

The @cue-ai/embedded package is released on two main channels:

• Production - Published from main
• Development - Published from development

Developing

Running the Dev Server

If you'd like to run the embedded example, first start the next package:

yarn workspace @cue-ai/next dev

Then, start the embedded package dev environment:

yarn workspace @cue-ai/embedded dev

which starts up a Vite React application.

Running Storybook

To run the storybook (which contains all the individual chart components), run:

yarn storybook

Component Information

Embedded Dashboard Provider

• Fetches both dataset data and dashboard data
• Initializes controlVariableAtoms
• Initializes and sets organizationAtom
• Initializes and sets themeMergeAtom
• Initializes and sets customerAtom
• Initializes and sets dashboardAtom
• Initializes and sets dashboardItems (which is an atom array)
• Initializes and sets datasetData (which contains dataset data and associated loading state)

Embedded Dashboard Renderer

• Reads data from dashboardAtom and dashboardItems to render the dashboard