Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@esri/configurable-app-components

Esri221Apache-2.01.7.0TypeScript support: included

"Custom 4.x widgets built with the ArcGIS API for JavaScript."

readme

Configurable App Components

npm version

Custom 4.x widgets built with the ArcGIS API for JavaScript.

Components

Each component directory contains general instructions on how to use the corresponding component.

  1. Info: Panel that displays customized string content in a list or paragraph form (Sample App).

Info

  1. Screenshot: Tool which provides the capability of taking screenshots of the map view/scene view. Optionally, include the legend or pop-up with the map screenshot (Sample App).

Screenshot

  1. Share: Dialogue that provides the capability of sharing a web application of the current map extent across customized social sharing platforms i.e. Facebook, Twitter, LinkedIn, or E-mail (Sample App).

Share

Requirements

  • ArcGIS API for JavaScript 4.x
  • Node
  • Web browser with access to the Internet
  • Your favorite IDE

Install via npm

npm i @esri/configurable-app-components

Typings

Include in tsconfig.json:

./node_modules/@esri/configurable-app-components/index.d.ts

Dojo config example

  const config = {
    async: true,
    locale: dojoLocale,
    packages: [
      {
        name: "Components",
        location: `${appPath}/node_modules/@esri/configurable-app-components`
      }
    ]
  };

Importing module into project

Naming convention: Components/[component_name]/[component_name]

Example:

import Share = require("Components/Share/Share");

import ShareItem = require("Components/Share/Share/ShareItem");

Namespace

After linking the typings file to your tsconfig.json, you can use the __esriConfigApps namespace for the types.

Adding CSS

Don't forget to link to the corresponding CSS file.

./node_modules/@esri/configurable-app-components/[component_name]/[component_name]/css/[component_name].css

<link rel="stylesheet"
    href="./node_modules/@esri/configurable-app-components/Screenshot/Screenshot/css/Screenshot.css">

Resources

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Licensing

Copyright 2019 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's LICENSE file.

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.6.9

  • FilterList
    1. explicitly check for null

1.6.8

  • FilterList
    1. Calcite update

1.6.7

  • FilterList
    1. If string has single quote, replace with two single quotes to properly escape character

1.6.6

  • Screenshot
    1. Additional RTL bug fixes

1.6.5

  • Screenshot
    1. RTL bug fixes
    2. Scrollbar fix

1.6.4

  • FilterList
    1. query.where bug fix

1.6.3

  • Screenshot
    1. Feature warning CSS fix

1.6.2

  • FilterList
    1. Add support for init expression values

1.6.1

  • FilterList
    1. coded values bug fix
    2. Add translations

1.6.0

  • Screenshot
    1. RTL Fixes

1.5.9

  • FilterList
    1. Add ability to expand FilterList accordions

1.5.8

  • FilterList bug fix
    1. Reset coded-value and range types
    2. Def Expression bug fix

1.5.7

  • FilterList layer field domain update
    1. Use field domain's constraints if it exist

1.5.6

  • Page
    1. Token bug fix

1.5.5

  • FilterList bug fixes
    1. Optional chaining if operator doesn't exist (older apps)
    2. Use allLayers instead of layers

1.5.3

  • Page
    1. Prefers-reduced-motion: Remove animation from 'Explore' button
    2. Add support for 'bg' locale

1.5.2

  • Share
    1. Add support for 'bg' locale
    2. Add aria-label to 'Copy to clipboard' buttons
    3. Remove 'projection' logic
    4. Resolve 'renderable()' helper method deprecation errors

1.5.1

  • FilterList bug fix and updated translations

1.5.0

  • Added 'disableCustom' property to Screenshot widget

1.4.8

  • Increase FilterList maxRecordCount for combobox string attribute

1.4.8

  • Update FilterList:
    1. Bug fixes for FilterList
    2. Query for min and max for user input filters

1.4.7

  • Update FilterList:
    1. Remove select/useCombobox; strings only use combobox
    2. Updated styling
    3. Add AND/OR description text
    4. Change number filter to slider

1.4.6

  • Added interactive filters to FilterList

1.4.5

  • Added joining operator "AND"/"OR" for FilterList

1.4.4

  • Page component: Update styles

1.4.3

  • Page component: Update t9n files

1.4.2

  • Page component updates

1.4.1

  • Page component updates

1.4.0

  • Page component updates

1.3.9

  • Page component updates

1.3.8

  • Page component updates

1.3.7

  • Page component updates

1.3.6

  • Added Page component

1.3.5

  • update FilterList translations

1.3.4

  • FilterList bug fix for initializing
  • Updates to handle JSAPI 4.19 changes
  • a11y imporovements for Share, Info, and Screenshot components

1.3.3

  • FilterList, styling bug fix

1.3.2

  • FilterList, add 6px gap to filter and optional button

1.3.1

  • FilterList
    1. Added key to div/accordion-item
    2. Updated theme for reset button container

1.3.0

  • i18n updates

1.2.9

  • i18n updates

1.2.8

  • FilterList, added optional button

1.2.7

  • FilterList bug fix

1.2.6

  • FilterList
    1. Updated output
    2. Added custom header HTML tag
    3. Updated README

1.2.5

  • FilterList NLS updates

1.2.4

  • Update FilterList component interfaces

1.2.3

  • Addition of FilterList component

1.2.2

  • Screenshot higlight fix

1.2.1

  • Screenshot higlight fix

1.2.0

  • Screenshot preview focus update

1.1.9

  • Screenshot preview focus update

1.1.8

  • Screenshot NLS updates

1.1.7

  • Screenshot bug fixes

1.1.6

  • Screenshot bug fixes

1.1.5

  • Screenshot
    1. Updated terms to 'Horizontal' and 'Vertical'

1.1.4

  • Share
    1. Add support for light/dark theme

1.1.3

  • Share
    1. Removed usage of calcite web
    2. Integrated calcite-modal and calcite-tabs from calcite components.

1.1.2

  • Share
    1. JSAPI modernization updates
    2. Remove usage of requireUtils

1.1.1

  • Screenshot
    1. Custom element to include in screenshot output.
    2. Option to set screenshot layout to row or colum.
    3. Add title to downloaded image.

1.1.0

  • Updated package-lock.json

1.0.9

  • Updated share widget to use esri/intl.substitute()
  • Remove hi locale support

1.0.8

  • Updated share widget to use replace

1.0.7

  • Typings update

1.0.6

  • Updated DOC to mention how to include CSS.

1.0.5

  • Updated index.d.ts
  • Share component bug fix.

1.0.4

  • Updated index.d.ts

1.0.3

  • Fixed Typings section in README.md

1.0.2

  • Updated README.md
  • Added release badge to README.md

1.0.1

  • Included ArcGIS API for JavaScript typings
  • Included typings for Components. Currently typed to any. Typings need additional work.

1.0.0

  • First Release