Angular
Angular plays nice with custom elements, so you can use Terra UI Components in your Angular apps with ease.
Installation
Download the npm package
To add Terra UI Components to your Angular app, install the package from npm.
npm install @nasa-terra/components
Update the Angular Configuration
Next, include a theme. In this example, we’ll import the light theme.
Its also important to load the components by using a <script> tag into the index.html
file. However, the Angular way to do it is by adding a script configurations into your angular.json file
as follows:
"architect": { "build": { ... "options": { ... "styles": [ "src/styles.scss", "@nasa-terra/components/dist/themes/horizon.css" ], "scripts": [ "@nasa-terra/components/dist/terra-ui-components.js" ] ...
Setting up the base path
Next, set the base path for icons and
other assets in the main.ts. In this example, we’ll use the CDN as a base path.
import { setBasePath } from '@nasa-terra/components/dist/utilities/base-path' setBasePath('https://cdn.jsdelivr.net/npm/@nasa-terra/components@0.0.138/cdn/')
If you’d rather not use the CDN for assets, you can create a build task that copies
node_modules/@nasa-terra/components/dist/assets into a public folder in your app. Then you
can point the base path to that folder instead.
Configuration
Then make sure to apply the custom elements schema as shown below.
import { BrowserModule } from '@angular/platform-browser' import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core' import { AppComponent } from './app.component' @NgModule({ declarations: [AppComponent], imports: [BrowserModule], providers: [], bootstrap: [AppComponent], schemas: [CUSTOM_ELEMENTS_SCHEMA], }) export class AppModule {}
Reference Terra UI Components in your Angular component code
import { TerraDrawer } from '@nasa-terra/components'; @Component({ selector: 'app-drawer-example', template: '<div id="page"><button (click)="showDrawer()">Show drawer</button><terra-drawer #drawer label="Drawer" class="drawer-focus" style="--size: 50vw"><p>Drawer content</p></terra-drawer></div>' }) export class DrawerExampleComponent implements OnInit { // use @ViewChild to get a reference to the #drawer element within component template @ViewChild('drawer') drawer?: ElementRef<TerraDrawer>; ... constructor(...) { } ngOnInit() { } ... showDrawer() { // use nativeElement to access Terra UI Components this.drawer?.nativeElement.show(); } }
Now you can start using Terra UI Components in your app!
Are you using Terra UI Components with Angular? Help us improve this page!