Jimu is a JavaScript library used to create a configurable experience and is the extensibility framework that consists of the following packages:

  • jimu-arcgis package contains classes and methods for working with the ArcGIS Maps SDK for JavaScript. Commonly used classes include JimuMapView and JimuMapViewComponent.
  • jimu-core package provides the interfaces and types to work with widget props, message actions, data source, etc. It also defines several classes that will be used throughout your experiences.
  • jimu-for-builder package provides classes for developing the widget setting page such as SettingChangeFunction and WidgetSettingProps.
  • jimu-for-test package contains classes, types, and functions that can be used for unit testing.
  • jimu-ui package includes UI components to be used in your experiences. For performance reasons, the UI components are split into three categories. The jimu-ui entry contains the general UI components, such as Button, Input, etc. The entries under jimu-ui/basic contains focused components, such as ColorPicker and QRCode. Entries under jimu-ui/advanced are heavy and complex, for example, the setting-components entry contains several components that may be used in the widget setting.

These packages use the same structure pattern so you can follow the same best practices to use them. Each package defines some entries for import, these entries are put under the root folder of the package. The contents in the lib folder should be considered as the internal contents for the package so you should not import them in your widget. For example, when you need to use the Button component from jimu-ui, you should import it like import {Button} from 'jimu-ui' instead of import {Button} from 'jimu-ui/lib/components/button'.

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