@deephaven/jsapi-bootstrap

@deephaven/jsapi-bootstrap

This is a library to bootstrap load the JS API. It provides functionality to load the API and set it in a context object, or to set it globally to retain legacy behaviour. Will display an error if unable to load the API.

Install

npm install --save @deephaven/jsapi-bootstrap

Usage

Using Context

import { ApiBootstrap, useApi } from '@deephaven/jsapi-bootstrap';

function MyComponent() {
  const api = useApi();

  ...
}

<ApiBootstrap apiUrl={API_URL}>
  <MyComponent />
</ApiBootstrap>;

Using API globally (legacy behaviour)

If you're using the JSAPI shim or relying on the API to be set globally, you'll need to lazily load your component first so the API is set before imports attempt to use it.

// App.tsx
import { ApiBootstrap } from '@deephaven/jsapi-bootstrap';

const MyComponent = React.lazy(() => import('./MyComponent'));

<ApiBootstrap apiUrl={API_URL} setGlobally>
    <Suspense fallback={<div>Loading...</div>}>
      <MyComponent />
    </Suspense>
</ApiBootstrap>;

// MyComponent.tsx
import dh from '@deephaven/jsapi-shim';
function MyComponent() {
  const client = new dh.CoreClient(...);

  ...
}

Changelog

0.97.0 (2024-10-23)

⚠ BREAKING CHANGES

• RefreshToken related classes have been removed from @deephaven/jsapi-components. This functionality did not actually work in Core, and was unused. The RefreshToken type is now defined in @deephaven/jsapi-types, as dh.RefreshToken.

Features

• @deephaven/jsapi-nodejs npm package (#2260) (72507d3)
• add monaco docs CSS override (#2250) (6b949d5), closes #2247
• Add render blocking errors to Chart (#2255) (74a5cb7)
• add thousands format for numbers (#2261) (0802f8a), closes #2253
• Branded type utils (#2264) (fff0155), closes #2263

Bug Fixes

• add gap between type and name in widget panel tooltip (#2258) (4e8ad58), closes #2254
• Fix Type in Spectrum Modal Overlay Background Color (#2267) (9d84d8d)
• Remove RefreshBootstrap and refresh token handling (#2257) (5686032)