ThemeWidget

This widget changes the theme of deck.gl between light mode and dark mode. Click the widget to toggle the theme.

info

• The ThemeWidget is mainly intended for minimal applications and to help developers test theme changes. More advanced applications that already support theming in their non-Deck UI will likely want to control change of deck themes using the same mechanism that is used for the remainder of their UI.

JavaScript

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

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

TypeScript

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

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

React

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

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

React Controlled

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

function App() {
  const [themeMode, setThemeMode] = useState<'light' | 'dark'>('light');

  return (
    <DeckGL>
      <ThemeWidget
        placement="top-left"
        themeMode={themeMode}
        onThemeModeChange={setThemeMode}
      />
    </DeckGL>
  );
}

Constructor

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

Types

ThemeWidgetProps

The ThemeWidget accepts the generic WidgetProps and:

lightModeTheme (object, optional)

• Default: Light Glass Theme

Styles for light mode theme.

darkModeTheme (object, optional)

• Default: Dark Glass Theme

Styles for dark mode theme.

initialThemeMode ('auto' | 'light' | 'dark')

• Default: 'auto'

Set the initial theme for uncontrolled usage. 'auto' inspects window.matchMedia('(prefers-color-scheme: dark)').

themeMode ('light' | 'dark', optional)

Controlled theme mode. When provided, the widget is in controlled mode and this prop determines the current theme. Use with onThemeModeChange to handle user interactions.

onThemeModeChange (Function, optional)

(newMode: 'light' | 'dark') => void

• Default: () => {}

Callback when the user clicks the theme toggle button.

lightModeLabel (string, optional)

• Default: 'Light Mode'

Tooltip message displayed while hovering a mouse over the widget when light mode is available.

darkModeLabel (string, optional)

• Default: 'Dark Mode'

Tooltip message displayed while hovering a mouse over the widget when dark mode is available.

Styles

Name	Type	Default
--icon-sun	SVG Data Url	Material Symbol Add
--icon-moon	SVG Data Url	Material Symbol Remove

Source

modules/widgets/src/theme-widget.tsx