1. Get started

  2.  Welcome
  3.  Get started
  4.  Run as a Windows service
  5.  Build your first app
  6.  Requirements
  7.  Accessibility support
  8.  Development overview
  9.  About release versions
  10.  What's new
  11.  Frequently asked questions
  12. Working with apps

  13.  Home page
  14.  Create or import an app
  15.  Edit and launch an app
  16.  Choose a theme
  17.  Select a map or scene
  18.  Add widgets
  19.  Widgets overview
  20.  Configure app attributes
  21.  Preview apps on smaller screens
  22.  Export as a template
  23.  Edit or preview template
  24.  Use URL parameters
  25.  Upgrade apps
  26. Configure 2D widgets

  27.  About widget
  28.  Add Data widget
  29.  Analysis widget
  30.  Attribute Table widget
  31.  Batch Attribute Editor widget
  32.  Basemap Gallery widget
  33.  Bookmark widget
  34.  Business Analyst widget
  35.  Chart widget
  36.  Controller widget
  37.  Coordinate widget
  38.  Coordinate Conversion widget
  39.  Cost Analysis widget
  40.  Data Aggregation widget
  41.  Directions widget
  42.  Distance and Direction widget
  43.  District Lookup widget
  44.  Draw widget
  45.  Edit widget
  46.  Emergency Response Guide widget
  47.  Extent Navigate widget
  48.  Filter widget
  49.  Full Screen widget
  50.  Geocoder widget
  51.  GeoLookup widget
  52.  Geoprocessing widget
  53.  Grid Overlay widget
  54.  Gridded Reference Graphic widget
  55.  Group Filter widget
  56.  Image Measurement widget
  57.  Home Button widget
  58.  Incident Analysis widget
  59.  Infographic widget
  60.  Info Summary widget
  61.  Layer List widget
  62.  Legend widget
  63.  Measurement widget
  64.  My Location widget
  65.  Near Me widget
  66.  Network Trace widget
  67.  Oblique Viewer widget
  68.  Overview Map widget
  69.  Parcel Drafter widget
  70.  Print widget
  71.  Public Notification widget
  72.  Query widget
  73.  Related Table Charts widget
  74.  Report Feature widget
  75.  Reviewer Dashboard widget
  76.  Scalebar widget
  77.  Screening widget
  78.  Search widget
  79.  Select widget
  80.  Share widget
  81.  Situation Awareness widget
  82.  Smart Editor widget
  83.  Splash widget
  84.  Stream widget
  85.  Suitability Modeler widget
  86.  Summary widget
  87.  Swipe widget
  88.  Threat Analysis widget
  89.  Time Slider widget
  90.  Visibility widget
  91.  Zoom Slider widget
  92. Configure 3D widgets

  93.  3DFx widget
  94.  About widget
  95.  Basemap Gallery widget
  96.  Compass widget
  97.  Coordinate widget
  98.  Daylight widget
  99.  Full Screen widget
  100.  Home Button widget
  101.  Layer List widget
  102.  Legend widget
  103.  Measurement widget
  104.  My Location widget
  105.  Navigate widget
  106.  Search widget
  107.  Share widget
  108.  Slides widget
  109.  Splash widget
  110.  Zoom Slider widget
  111. Widget development

  112.  Get started
  113.  Naming conventions
  114.  In-panel and off-panel widgets
  115.  Deploy your widget
  116.  Required files
  117.  Widget manifest
  118.  Extend BaseWidget
  119.  Required properties
  120.  Define the template
  121.  Configure the Demo widget
  122.  Add i18n support
  123.  Make widgets user-friendly
  124.  Build your first app
  125.  Communication to app container
  126.  Widget properties
  127.  Make widgets responsive
  128.  Communication between widgets
  129.  Dojo dijit
  130.  Make widgets configurable in builder
  131.  Make widgets backward compatible
  132.  Create a controller widget
  133.  Widget life cycle
  134.  Add help for your widget
  135.  Create a feature action in your widget
  136.  Provide and consume data sources in widgets
  137.  Best practices for unit testing
  138. Theme development

  139.  Theme elements
  140.  Create a theme
  141. 3D development

  142.  3D development guide
  143. Sample code

  144.  Create a custom in-panel widget
  145.  Create a ListView widget
  146.  Create a custom widget using the Report dijit
  147.  Create a new theme
  148.  Create a new style for a theme
  149.  Create a new default layout
  150.  Create a nondefault layout
  151.  Create a new panel
  152.  Create a new layout widget
  153.  Create a controller widget
  154.  Create a feature action in your widget
  155.  Send a layer to the Attribute Table widget
  156.  Open multiple widgets simultaneously
  157.  Use other libraries
  158.  Change the URL of ArcGIS API for JavaScript
  159. Deployment

  160.  Deploy your app
  161.  Use proxy
  162.  Web-tier authentication
  163.  Custom widget and theme deployment
  164.  Upgrade custom widgets and themes
  165. Framework reference

  166.  CSS framework
  167.  FeatureActionManager class
  168.  FilterManager class
  169.  LayerInfo class
  170.  LayerInfos class
  171.  LayerNode class
  172.  LayerStructure class
  173.  PanelManager class
  174.  SelectionManager class
  175.  Utils class
  176.  WidgetManager class
  177. dijit

  178.  FeaturelayerChooserFromMap class
  179.  FeaturelayerServiceBrowser class
  180.  FeatureSetChooserForSingleLayer class
  181.  Filter class
  182.  ImageChooser class
  183.  ItemSelector class
  184.  LayerChooserFromMap class
  185.  RendererChooser class
  186.  Report class
  187.  SnapShot class
  188.  SymbolChooser class
  189. JSON reference

  190.  App configuration
  191.  Map configuration
  192.  Widget configuration
  193.  Widget pool configuration
  194.  Widget on-screen configuration
  195.  Panel configuration
  196.  Group configuration
  197.  DataSource configuration
  198.  About
  199.  Analysis
  200.  Attribute Table
  201.  Basemap Gallery
  202.  Bookmark
  203.  Chart
  204.  Coordinate
  205.  Directions
  206.  Draw
  207.  Edit
  208.  Full Screen
  209.  Geocoder
  210.  Geoprocessing
  211.  Controller
  212.  Home Button
  213.  Image Measurement
  214.  Infographic
  215.  Layer List
  216.  Legend
  217.  Loading Page
  218.  Measurement
  219.  My Location
  220.  Near Me
  221.  Oblique Viewer
  222.  Overview Map
  223.  Print
  224.  Query
  225.  Report Feature
  226.  Reviewer Dashboard
  227.  Scalebar
  228.  Search
  229.  Share
  230.  Splash
  231.  Stream
  232.  Swipe
  233.  Time Slider
  234.  Zoom Slider
  235. What's new archive

  236.  What's new in version 2.23
  237.  What's new in version 2.22
  238.  What's new in version 2.21
  239.  What's new in version 2.20
  240.  What's new in version 2.19
  241.  What's new in version 2.18
  242.  What's new in version 2.17
  243.  What's new in version 2.16
  244.  What's new in version 2.15
  245.  What's new in version 2.14
  246.  What's new in version 2.13
  247.  What's new in version 2.12
  248.  What's new in version 2.11
  249.  What's new in version 2.10
  250.  What's new in version 2.9
  251.  What's new in version 2.8
  252.  What's new in version 2.7
  253.  What's new in version 2.6
  254.  What's new in version 2.5
  255.  What's new in version 2.4
  256.  What's new in version 2.3
  257.  What's new in version 2.2
  258.  What's new in version 2.1
  259.  What's new in version 2.0
  260.  What's new in version 1.3
  261.  What's new in version 1.2
  262.  What's new in version 1.1

Create a new style for a theme

You can create a basic style in ArcGIS Web AppBuilder to customize brand colors, fonts, and other basic UI properties in a theme. Although this topic uses a Jewelry Box theme, it applies to other themes in ArcGIS Web AppBuilder as well.

The new style modifies the following CSS properties of UI elements:

The UI components to be styled in the Jewelry Box theme are the HeaderController widget, a foldable panel, and a map pop-up.

NoteNote:

The above list of to-be-styled components can vary from theme to theme depending on the available widgets, panels, and other UI elements in the theme.

Create a new style folder

Create a new folder by completing the following steps.

Steps:
  1. Go to the styles folder in the theme, for example, ~/client/stemapp/themes/JewelryBoxTheme/styles.
  2. Create a new folder and name it myStyle.
  3. Create a new style.css file in the myStyle folder.

    Optionally, you can add more folders and style sheets, such as images or .lib files, in the myStyle folder. Keep in mind that all resources must be referenced in the style.css file.

    The folder structure should look like this:

    myStyle folder structure

Register the style in the manifest.json file

To display the new style in ArcGIS Web AppBuilder, register it in the theme's manifest.json file.

Steps:
  1. Open the manifest.json file from ~/client/stemapp/themes/JewelryBoxTheme/manifest.json.
  2. Add the following myStyle properties to the styles:
    1. "name"—Must match the name of the style folder.
    2. “description”—The style description.
    3. “styleColor”—Defines the background of the style’s representative swatch in the ArcGIS Web AppBuilder UI. The value can be a valid color name or a HEX.

    The code snippet in the manifest.json file should look similar to the following:

    {
          "name": "myStyle",
          "description": "this is demo style",
          "styleColor": "#eee"
        }
    

  3. Reload the app. The new style appears under the Jewelry Box theme as shown below.
    New style

Override brand colors for the HeaderController widget

To update the main color scheme with black and white for the HeaderController widget, you'll add CSS styles to the style.css file.

Steps:
  1. Make the background color white (#fff).
    .jimu-main-background {
      background-color: #fff;
    }
    

    The class name for the background-color property is jimu-main-background. It is a common class name from the Jimu CSS framework and may have an impact on other UI elements. For a full list of Jimu CSS class names, see CSS framework.

  2. Change the title and subtitle colors in the header to dark gray (#323232).
    .jimu-title,
    .jimu-subtitle {
      color: #323232;
    }
    
  3. Remove the shadow and add a border at the bottom. Unlike the class names in steps 1 and 2 from Jimu CSS framework, a widget-specific class name is used here.
    .jimu-widget-header-controller {
      -moz-box-shadow: none;
      -webkit-box-shadow: none;
      box-shadow: none;
      border-bottom: 3px solid #323232;
    }
    

    A widget-specific class name follows the pattern of jimu-widget-{widgetname}.

  4. Change the background color, remove the right border, and change the opacity of the icon nodes.
    .jimu-widget-header-controller .icon-node {
      opacity: 1;
      background: #323232;
      border-right: 0;
    }
    

    Now the HeaderController should look like this:

    New background color for HeaderController widget

  5. Add styles to resize and align the icon nodes properly.
    1. Make the icon nodes smaller.
      .jimu-widget-header-controller .icon-node {
        opacity: 1;
        background: #323232;
        border-right: 0;
        height: 30px !important;
        width: 30px !important;
      }
      

      With !important, the HeaderController widget dynamically adds inline styles and calculates the height of the icon nodes by reading the height property defined in the layout.json file.

    2. Add margin properties to align the icon nodes.
      .jimu-widget-header-controller .icon-node {
        opacity: 1;
        background: #323232;
        border-right: 0;
        height: 30px !important;
        width: 30px !important;
        margin-top: 4px;
        margin-right: 10px;
      }
      
    3. Add additional styles, such as border-radius.
      .jimu-widget-header-controller .icon-node {
        opacity: 1;
        background: #323232;
        border-right: 0;
        height: 30px !important;
        width: 30px !important;
        margin-top: 4px;
        margin-right: 10px;
        -moz-border-radius: 50%;
        -webkit-border-radius: 50%;
        border-radius: 50%;
      }
      
    4. Make the icon images smaller.
      .jimu-widget-header-controller .icon-node img {
        height: 14px;
        width: 14px;
      }
      

      The HeaderController widget should now look like this:

      New icon images for HeaderController widget

    5. Add selected state styles.
      .jimu-widget-header-controller .icon-node.jimu-state-selected {
        border-top: 0;
        background-color: #2196f3;
      }
      

      Jimu defines a list of state classes. In this example, jimu-state-selected is used.

    6. Add the CSS rule to override widget group icons when the group display mode is show in Dropdown Menu. See Controller widget for more information.

      To align the drop-down arrow correctly in a widget group icon node, place the drop-down arrow at the bottom center of the icon node.

      .jimu-widget-header-controller .drop-triangle {
          bottom: 5px;
          margin-left: -5px;
      }
      

      Make the background color of the drop-down menu dark gray (#323232).

      .jimu-widget-header-controller .jimu-drop-menu {
        background-color: #323232;
      }
      

      Make the widget icons in the drop-down menu the same size as other widget icons to align them correctly.

      .jimu-widget-header-controller .jimu-drop-menu .menu-item img {
        width: 14px;
        height: 14px;
        margin-top: 13px;
      }
      

      Make the text labels in the drop-down menu smaller.

      .jimu-widget-header-controller .jimu-drop-menu .menu-item .label {
          font-size: 12px;
      }
      

      The widget group icon should look something like this when opened:

      New widget group icon

  6. Change the link color in the header to gray (#666), and add a few links in ArcGIS Web AppBuilder.
    .jimu-link:link, .jimu-link:visited {
      color: #666;
    }
    

    The links display in gray in the HeaderController widget.

    Updated links

  7. The controllers in themes such as Foldable, Jewelry Box, and LaunchPad have the ability to wrap any widget icons into more widget pop-ups when there is not enough space. Complete the following steps to add a more widgets icon More widgets icon and restyle the pop-up.
    1. Make the overlay DIV, which covers the entire screen when the pop-up opens, opaque white.
      .jimu-more-icon-cover {
        background-color: #323232;
        opacity: .65;
      }
      
    2. Change the background color of the pop-up to black (#000).
      .jimu-header-more-popup {
        background: #000;
      }
      
    3. Change the background color of the icon tiles to dark gray (#323232).
      .jimu-header-more-popup .icon-node {
        background-color: #323232;
      }
      
    4. Change the background color of the pop-up footer (pagination) to black (#000).
      .jimu-header-more-popup .points {
        background: #000;
      }
      
    5. Adjust the Close button and pagination dots styles.

      Use blue (#2196f3) for the Close button.

      .jimu-header-more-popup .close,
      .jimu-header-more-popup .close-inner {
        background-color: #2196f3;
      }
      

      Make the pagination dots smaller and apply gray (#9e9e9e—normal state) and white (#fff—active state) to the background colors.

      .jimu-header-more-popup .points-inner {
        position: relative;
        top: -3px;
      }
      .jimu-header-more-popup .point {
        width: 5px;
        height: 5px;
        background-color: #9e9e9e;
      }
      .jimu-header-more-popup .point-selected {
        background-color: #fff;
      }
      

    6. Resize the icon images to make them smaller.
      .jimu-header-more-popup img {
        height: 30px !important;
        width: 30px !important;
      }
      

    Now the pop-up looks like this:

    New pop-up for the More widget

Override brand colors for panel widgets

The panel widgets include foldable panels and on-screen panels. For the title panes in panel widgets in myStyle, the background colors will be updated in blue, and the borders will be removed.

Steps:
  1. For both on-screen and foldable panels, change the background color of the title panes to blue (#2196F3).
    .jimu-on-screen-widget-panel>.jimu-panel-title,
    .jimu-foldable-panel>.jimu-panel-title {
      background-color: #2196F3;
    }
    
  2. Remove the borders.
    .jimu-panel {
      border: 0;
    }
    
    New style for panel widgets
  3. All of the panel widgets share the same class name, jimu-panel, at the root level of the .html structure.

Override brand colors for the map pop-up widget

Similar to the panel widgets, change the background colors of the pop-up's title pane.

Steps:
  1. Change the background color of the pop-up’s title pane to blue (#2196F3).
    .esriPopup .titlePane {
      background-color: #2196F3;
    }
    
    New style for map pop-up

Use a different font family

Change the default font to Open Sans. The jimu-main-font is the class name from the Jimu class framework.

Steps:
  1. By default, theOpen Sans font is not available on many devices. To import it, add the following line of code at the beginning of the style.css file in myStyle:

    @import url(//fonts.googleapis.com/css?family=Open+Sans);

  2. Override the default font in .jimu-main-font.
    .jimu-main-font {
      font-family: 'Open Sans';
    }
    
    New font