Build a dark mode switch

Learn how to create a component that switches Calcite Components and ArcGIS Maps SDK for JavaScript in dark mode.

You will use Calcite Components to design an elegant dark mode switch that enables the dark mode for Calcite Components, as well as ArcGIS Maps SDK for JavaScript widgets and basemaps. This application builds on the one created in the Create a mapping app tutorial.

Calcite provides light and dark modes which can be changed using CSS classes: calcite-mode-light (default) and calcite-mode-dark. There is also a calcite-mode-auto class which defers to the browser's CSS prefers-color-scheme media query. Setting the mode class on an element changes all of their child nodes as well.

For more information about mode and styling, visit Calcite Design System's colors and modes foundation and ArcGIS Maps SDK for JavaScript's styling documentation.

Prerequisites

ArcGIS developer account
You need a free ArcGIS developer account or an account associated with an ArcGIS Online organization to access the services used in this tutorial.

Steps

Create a new pen

  1. To get started, either complete the Create a mapping app tutorial or .

Use an API key

An API key is required to access ArcGIS services if you are using a developer account. You can skip this step if you have an account associated with an ArcGIS Online organization.

  1. Go to your developer dashboard to get an API key.
  2. In CodePen > <script>, import the esriConfig class.
  3. Set the apiKey property.
Use dark colors for code blocks
1
2
3
4
  "esri/widgets/Print",
  "esri/config"
], function (WebMap, MapView, Bookmarks, BasemapGallery, LayerList, Legend, Print, esriConfig ) {
esriConfig.apiKey = "YOUR_API_KEY";

Add theme stylesheets

The ArcGIS Maps SDK for JavaScript uses separate theme stylesheets. Add both light and dark stylesheets, which will be dynamically toggled in JavaScript using their id attributes.

  1. Add the dark theme stylesheet, set the disabled attribute, and add an id.
  2. Add an id to the preexisting light theme stylesheet.
Expand
Use dark colors for code blocks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
  <script src="https://js.arcgis.com/calcite-components/2.13.2/calcite.esm.js" type="module"></script>
  <link rel="stylesheet" href="https://js.arcgis.com/calcite-components/2.13.2/calcite.css" />
  <script src="https://js.arcgis.com/4.30/"></script>

  <link disabled id="arcgis-maps-sdk-theme-dark" rel="stylesheet"
    href="https://js.arcgis.com/4.30/esri/themes/dark/main.css" />

  <link id="arcgis-maps-sdk-theme-light" rel="stylesheet"
    href="https://js.arcgis.com/4.30/esri/themes/light/main.css" />
Expand

Add HTML

The primary component in the dark mode switch is calcite-switch. The mode switcher will also use calcite-label to provide context when the dark mode is toggled.

  1. In the calcite-navigation component, add a div element and place it in the Navigation's content-end slot with an id attribute used later for styling.
  2. Add a calcite-label component. Set the layout attribute to "inline", and add a class attribute used later for styling.
  3. Add the calcite-switch component.
Expand
Use dark colors for code blocks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251

<body>
  <calcite-loader></calcite-loader>
  <calcite-shell content-behind hidden>

    <calcite-navigation slot="header">
      <calcite-navigation-logo id="header-title" heading-level="1" slot="logo">
        <!-- Dynamically populated -->
      </calcite-navigation-logo>

      <div slot="content-end">
        <!-- Dark Mode Switch -->
        <calcite-label layout="inline" class="label-wrapper">
          Dark mode: Off
          <calcite-switch></calcite-switch>
          On
        </calcite-label>
      </div>

    </calcite-navigation>
Expand

Add CSS

At this point, if you run the app you will see the dark mode switcher slotted in the Navigation's "content-end" slot.

Next, add styling with CSS to position the component using Flexbox.

  1. In the <style> element, add CSS for the dark mode switch's layout by setting the margin-inline and padding CSS properties. Add a border using the --calcite-color-border-1 CSS variable for the color. Next, add a margin CSS property to the calcite-switch, which will accommodate future controls in the interface.

  2. Next, add the calcite-label's --calcite-label-margin-bottom CSS variable to set spacing below the component.

    Expand
    Use dark colors for code blocks
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
      calcite-label {
        --calcite-label-margin-bottom: 0px;
      }
    
    
    Expand
  3. Finally, set the Switch's cursor property to "pointer" to communicate that the Switch container is clickable.

    Expand
    Use dark colors for code blocks
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
      .label-wrapper {
        display: flex;
        margin-inline: 1rem;
        padding: 0.5rem;
        border: 1px solid var(--calcite-color-border-1);
        cursor: pointer;
      }
    
    
    Expand

Add JavaScript

Now you have a good looking component; but it doesn't enable dark mode. Next, wire up the dark mode switcher with JavaScript.

  1. In the <script> element, below the existing JavaScript code, create a new function to enable dark mode.
  2. Switch the calcite-mode-dark class on the <body> element. No need to add the calcite-mode-light class, since it is the default.
  3. Access the ArcGIS Maps SDK for JavaScript light and dark stylesheets using the id attributes you added above.
  4. Negate the disabled attribute on both stylesheets to toggle their boolean values.
  5. Change the basemap between gray-vector and dark-gray-vector depending on the current mode.
  6. Toggle the calcite-mode-dark class across ArcGIS Maps SDK for JavaScript's widgets using .esri-ui.
  7. Add an event listener to the calcite-switch component. Listen for the calciteSwitchChange event and provide the function you created.
Expand
Use dark colors for code blocks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
      document.querySelector("calcite-shell").hidden = false;
      document.querySelector("calcite-loader").hidden = true;

      const updateDarkMode = () => {
        // Calcite mode
        document.body.classList.toggle("calcite-mode-dark");
        // ArcGIS Maps SDK theme
        const dark = document.querySelector("#arcgis-maps-sdk-theme-dark");
        const light = document.querySelector("#arcgis-maps-sdk-theme-light");
        dark.disabled = !dark.disabled;
        light.disabled = !light.disabled;
        // ArcGIS Maps SDK basemap
        map.basemap = dark.disabled ? "gray-vector" : "dark-gray-vector";
        // Toggle ArcGIS Maps SDK widgets mode
        const widgets = document.getElementsByClassName("esri-ui");
        for (let i = 0; i < widgets.length; i++) {
          widgets.item(i).classList.toggle("calcite-mode-dark");
        }
      };

      document.querySelector("calcite-switch").addEventListener("calciteSwitchChange", updateDarkMode);

    });
  });
</script>

</html>

Run the app

In CodePen, run your code to display the application.

In the top, right corner of the screen you will see the new, beautiful dark mode switcher component. Clicking anywhere on the component will toggle the calcite-switch. The function you created for the event listener will run, which will toggle Calcite Components in dark mode, as well as the ArcGIS Maps SDK for JavaScript basemap and widgets.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.