icon-widget.md

IconWidget

import {IconWidgetDemo} from '@site/src/doc-demos/widgets'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

This widget renders a single icon button. Use it for simple actions that should live alongside the other built-in deck.gl widgets.

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

new Deck({
  widgets: [
    new IconWidget({
      icon: `./run.svg`,
      label: 'Run!',
      onClick: () => alert('Running!')
    })
  ]
});

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

new Deck({
  widgets: [
    new IconWidget({
      icon: `./run.svg`,
      label: 'Run!',
      onClick: () => alert('Running!')
    })
  ]
});

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

function App() {
  return (
    <DeckGL>
      <IconWidget
        icon="./run.svg"
        label="Run!"
        onClick={() => alert('Running!')}
      />
    </DeckGL>
  );
}

Constructor

import {IconWidget, type IconWidgetProps} from '@deck.gl/widgets';
new IconWidget({} satisfies IconWidgetProps);

Types

IconWidgetProps {#iconwidgetprops}

The IconWidget accepts the generic WidgetProps and:

icon (string, required) {#icon}

Data URL used as the button icon mask.

label (string, optional) {#label}

Tooltip message displayed while hovering over the widget.

tooltip (string | HTMLElement | false, optional) {#tooltip}

• Default: value of label

Custom tooltip content. Overrides the default label text in the tooltip. Pass false to disable.

color (string, optional) {#color}

CSS color applied to the icon.

onClick (function, optional) {#onclick}

() => void

Callback invoked when the button is clicked.

Styles

The IconWidget uses the shared button theme variables described in the styling guide.

Source

modules/widgets/src/icon-widget.tsx