Skip to main content

Angular Installation

Installation

Install the Angular package using your preferred package manager:

npm install @a13y/angular @a13y/core
# or
yarn add @a13y/angular @a13y/core
# or
pnpm add @a13y/angular @a13y/core

Peer Dependencies

Make sure you have Angular 18+ installed:

npm install @angular/core@^18.0.0 @angular/common@^18.0.0

Usage with Standalone Components

Import components directly in your standalone components:

import { Component } from '@angular/core';
import { AccessibleButtonComponent } from '@a13y/angular';

@Component({
  selector: 'app-demo',
  standalone: true,
  imports: [AccessibleButtonComponent],
  template: `
    <accessible-button (click)="handleClick()">
      Click me
    </accessible-button>
  `
})
export class DemoComponent {
  handleClick() {
    console.log('Clicked!');
  }
}

Usage with NgModules

Or import in your NgModule:

import { NgModule } from '@angular/core';
import { AccessibleButtonComponent } from '@a13y/angular';

@NgModule({
  imports: [AccessibleButtonComponent],
  // ...
})
export class AppModule { }

TypeScript Support

@a13y/angular is written in TypeScript and includes full type definitions out of the box.