Skip to content

An Angular package wrapping Checka11y.css during the development process to quickly highlight some common accessibility errors and warnings that can be easily and quickly rectified.

Notifications You must be signed in to change notification settings

AlaaEl-DinAhmed/ngx-checka11y

Repository files navigation

Checka11y.css logo

GitHub Repo stars npm npm bundle size npm


ngxChecka11y

An Angular package wrapping Checka11y.css during the development process to quickly highlight some common accessibility errors and warnings that can be easily and quickly rectified.

Installation

Using npm

npm i checka11y-css@1.3.2 --save-dev

Using yarn

yarn add checka11y-css@1.3.2 --dev


Usage

Add CheckA11yModule to your app.module.ts and inject a provider for the environment to be avialable to the ngx-checka11y package.

import { CheckA11yModule } from "ngx-checka11y";
import { environment } from "../environments/environment";
@NgModule({
  imports: [
      ...,
      CheckA11yModule
    ],
  providers: [{ provide: 'environment', useValue: environment }],
})

Add ngxCheckA11y directive to whatever HTML element

or

<ng-container ngxCheckA11y></ng-container>

in the app.component.html or whatever component you want.

About

An Angular package wrapping Checka11y.css during the development process to quickly highlight some common accessibility errors and warnings that can be easily and quickly rectified.

Topics

Resources

Stars

Watchers

Forks