@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.32.0 (2023-03-10)

Bug Fixes

• DH-12163 - Column grouping sidebar test failure fixes (#1142) (a55308d)
• Fixed rollup divider position (#1125) (859bfa2), closes #1062
• Grid rendering header incorrectly when hiding all children in a group via layout hints (#1139) (2fbccc6), closes #1097

Code Refactoring

• Replace usage of Column.index with column name (#1126) (7448a88), closes #965

Features

• Add support for clickable links (#1088) (f7f918e), closes #712

BREAKING CHANGES

• Removed index property from dh.types Column type. IrisGridUtils.dehydrateSort now returns column name instead of index. TableUtils now expects column name instead of index for functions that don't have access to a columns array.