LoadingWidget (Experimental)

This widget shows a spinning indicator while any deck.gl layers are loading data.

JavaScript

import {Deck} from '@deck.gl/core';
import {_LoadingWidget as LoadingWidget} from '@deck.gl/widgets';
import '@deck.gl/widgets/stylesheet.css';

new Deck({
  widgets: [
    new LoadingWidget({placement: 'top-left'})
  ]
});

TypeScript

import {Deck} from '@deck.gl/core';
import {_LoadingWidget as LoadingWidget} from '@deck.gl/widgets';
import '@deck.gl/widgets/stylesheet.css';

new Deck({
  widgets: [
    new LoadingWidget({placement: 'top-left'})
  ]
});

React

import React from 'react';
import DeckGL, {_LoadingWidget as LoadingWidget} from '@deck.gl/react';
import '@deck.gl/widgets/stylesheet.css';

function App() {
  return (
    <DeckGL>
      <LoadingWidget placement="top-left" />
    </DeckGL>
  );
}

Installation

npm install deck.gl
# or
npm install @deck.gl/core @deck.gl/widgets

import {_LoadingWidget as LoadingWidget, type LoadingWidgetProps} from '@deck.gl/widgets';
import '@deck.gl/widgets/stylesheet.css';
new LoadingWidget({} satisfies LoadingWidgetProps);

To use pre-bundled scripts:

<script src="https://unpkg.com/deck.gl@^9.0.0/dist.min.js"></script>
<link href="https://unpkg.com/deck.gl@^9.0.0/dist/stylesheet.css" rel='stylesheet' />
<!-- or -->
<script src="https://unpkg.com/@deck.gl/core@^9.0.0/dist.min.js"></script>
<script src="https://unpkg.com/@deck.gl/widgets@^9.0.0/dist.min.js"></script>
<link href="https://unpkg.com/@deck.gl/widgets@^9.0.0/dist/stylesheet.css" rel='stylesheet' />

new deck._LoadingWidget({});

Types

LoadingWidgetProps

The InfoWidget accepts the generic WidgetProps and:

label (string, optional)

• Default: 'Loading data'

Tooltip message displayed while hovering a mouse over the widget.

Source

modules/widgets/src/loading-widget.tsx