A set of Angular components that wrap Calcite Components. An application using this package is provided in the calcite-components-examples
repo.
The following is an outline of the steps required to use @esri/calcite-components-angular
in an application. See the example for a complete application.
npm install @esri/calcite-components-angular
This package includes the compatible version of the main component library as a dependency, so no need to install @esri/calcite-components
separately.
Calcite Components rely on assets being available at a particular path. If using assets locally, you'll need to copy these over to your src
directory:
cp -r node_modules/@esri/calcite-components/dist/calcite/assets/ ./src/assets/
Import the global stylesheet into your app (only do this once):
/* src/styles.css */
@import "@esri/calcite-components/dist/calcite/calcite.css";
The Angular wrapper components must use Calcite Component's Distribution build:
// src/main.ts
import { defineCustomElements } from "@esri/calcite-components/dist/loader";
defineCustomElements(window, { resourcesUrl: "./assets" });
Add CalciteComponentsModule
to the imports of your Angular component's module:
// src/app/app.module.ts
import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { CalciteComponentsModule } from "@esri/calcite-components-angular";
import { AppComponent } from "./app.component";
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule, CalciteComponentsModule],
providers: [],
bootstrap: [AppComponent],
})
export class AppModule {}
Calcite Components can now be used in your application like any other Angular component!
<!-- app.component.html -->
<calcite-slider min="1" max="100" [value]="sliderValue" (calciteSliderInput)="onSliderInput($event)"></calcite-slider>
We welcome contributions to this project. See CONTRIBUTING.md for an overview of the guidelines.
COPYRIGHT © 2024 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: contracts@esri.com