Home

Awesome

<p align="center"> <a href="https://github.com/Celtian/ngx-app-version" target="blank"><img src="assets/logo.svg?sanitize=true" alt="" width="120"></a> <h1 align="center">NgxAppVersion</h1> </p>

npm version Package License NPM Downloads Snyk codecov stars forks HitCount

Angular directive for writing version into DOM

Angular 18 compatible

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

🛠️ 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

Angularngx-app-versionInstall
>= 141.xyarn add ngx-app-version
>= 120.xyarn add ngx-app-version@0

⚙️ Options

Root options

OptionTypeDefaultDescription
versionstringundefinedversion that will be rendered

📦 Dependencies

None

🪪 License

Copyright © 2023 - 2024 Dominik Hladik

All contents are licensed under the MIT license.