@esri/hub-web-components

Hub Web Components

Lumina based Web components for embedding ArcGIS Hub capabilities into websites and custom applications.

Quick Start

# install git LFS (large file storage)
# on a mac:
brew install git-lfs
git lfs install

npm install

To view components in harness pages, run npm start

To build run npm build

Lumina

This project was original scaffolded from the Lumina Starter Package. See Lumina documentation.

Linting

This package uses lint-staged to run ESLint and Prettier to clean up staged files before committing. All files are checked for linting or formatting errors in CI.

To lint all files locally run npm run lint.

To format all files locally run npm run format:fix

Testing

This package uses vitest to run unit tests with Playwright for browser mode. It also uses Playwright to run component end to end (e2e) tests, which you can learn more about here.

All tests are run in CI and the jobs will fail if any tests do not pass.

In order to run tests locally in a browser you must first run npm run test:install.

After that you can:

• run all tests with npm test
• run unit with npm run test:unit
• run component e2e tests with npm run test:e2e
• see code coverage with npm run test:coverage
• run unit tests repeatedly as you develop with npm run test:watch (includes code coverage report)
• debug unit tests with npm run test:debug

Release

See our release documentation.

License

COPYRIGHT © 2025 Esri

All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.

This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.

See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english

For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA

email: [e-mail]