Skip to content

Celtian/ngx-app-version

Repository files navigation

NgxAppVersion

npm version Package License NPM Downloads Snyk codecov stars forks HitCount

Angular directive for writing version into DOM

Angular 17 compatible

Here's the demo or stackblitz live preview or codesandbox live preview

  • Lightweight
  • No dependencies!
  • Directive way
  • Customizable options...

Install

  1. Use yarn (or npm) to install the package
yarn add ngx-app-version
  1. Add provideAppVersion into your config
import { provideAppVersion } from 'ngx-app-version';

export const appConfig: ApplicationConfig = {
  providers: [
    // ...
    provideAppVersion({
      version: '1.0.0'
    })
  ]
};

or module

  import { provideAppVersion } from 'ngx-app-version';

  @NgModule({
   // ...
   providers: [
     // ...
     provideAppVersion({
       version: '1.1.1'
     })
   ]
  })

Note: Do you want to get version from package.json? Consider to use ngx-devkit-builders.

Quick start

Directive example

<div ngxAppVersion>...</div>
<div app-version="1.1.1">...</div>

Host directive example

import { NgxAppVersionDirective } from 'ngx-app-version';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrl: './app.component.scss',
  hostDirectives: [NgxAppVersionDirective]
})
export class AppComponent {}
<app-root app-version="1.1.1">...</app-root>

Compatibility

Angular ngx-app-version Install
>= 14 1.x yarn add ngx-app-version
>= 12 0.x yarn add ngx-app-version@0

Options

Root options

Option Type Default Description
version string undefined version that will be rendered

Dependencies

None

License

Copyright © 2023 - 2024 Dominik Hladik

All contents are licensed under the MIT license.