WhatsNewKit for Ionic (Angular)

A NPM Package to easily showcase your new app features in your Ionic Angular App.
It's designed from the ground up to be fully customized to your needs.

Original Swift Package SvenTiigi/WhatsNewKit

export class HomePage implements OnInit  {

  constructor(
    protected updateWNKService: UpdateWNKService,
  ) {
  }

  ngOnInit() {
    this.updateWNKService.whatsNew();
  }
}

Features

• Easily present your new app features 🤩
• Automatic & Manual presentation mode ✅
• Dark mode ready ☑️
• Use Ionic Theming Colors 🎨
• Support for Ionic - Angular and Capacitor 🧑‍🎨
• Support any platform: iOS, macOS, iPadOS, Android, Web & Electron 📱 🖥
• Adjustable content 🔧

See complete documentation.

Installation

1. Install package from NPM using npm i @awwwesome-cz/whats-new-kit.
2. Create Custom Service for automatic presentation.
3. Call this.updateWNKService.whatsNew() on your page.

See complete documentation.

Example

Development info

1. Developing library in projects like whats-new-kit.
2. Run ng build or ng build --watch (for live reload) for build dev distribution of lib.
3. Go to cd dist/whats-new-kit or different lib.
4. Run npm link for link dev distribution to global node_modules folder.

Testing in real application

1. Create blank Ionic application ionic start dist-test-app blank --type=angular --capacitor
2. Go to ionic blank app
3. Run npm link @awwwesome-cz/whats-new-kit for link dev dist distribution from global node_modules folder.
4. Open angular.json in test app and add "preserveSymlinks": true

{
  // ...
  "projects": {
    "app": {
      // ...
      "architect": {
        "build": {
          // ...
          "options": {
            "preserveSymlinks": true
            // <--- add this
            // ...
          }
        }
      }
    }
  }

Licence

WhatsNewKit for Ionic (Angular)

Copyright (c) 2022 Ing. Jakub Josef Forman forman@awwwesome.cz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.