Skip to content

Commit

Permalink
docs: Add StackBlitz live demo link to README.md
Browse files Browse the repository at this point in the history
- Added interactive StackBlitz example for the `@ngx-smart-forms/smart-error-display` library.
- Users can now view and test the component directly via the StackBlitz link.
  • Loading branch information
AditechGH committed Oct 1, 2024
1 parent 9348c00 commit 9cbc129
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions libs/smart-error-display/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The `@ngx-smart-forms/smart-error-display` is an advanced Angular component that
## Table of Contents

- [Key Features](#key-features)
- [Live Demo](#live-demo)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Basic Usage with Reactive Forms](#basic-usage-with-reactive-forms)
Expand Down Expand Up @@ -36,6 +37,14 @@ The `@ngx-smart-forms/smart-error-display` is an advanced Angular component that
- **Performance Optimization**: Utilizes `OnPush` change detection strategy for optimal performance in large forms.
- **Error Handling**: Includes fallback mechanisms to handle and display errors gracefully, highlighting affected input fields when needed.

## Live Demo

Check out a live interactive demo of the `@ngx-smart-forms/smart-error-display` component on StackBlitz:

[![Edit @ngx-smart-forms/smart-error-display Example](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/stackblitz-starters-xlgvbh)

You can also click [here](https://stackblitz.com/edit/stackblitz-starters-xlgvbh) to open the project in a new tab.

## Installation

To install the library, use npm:
Expand Down
2 changes: 1 addition & 1 deletion libs/smart-error-display/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ngx-smart-forms/smart-error-display",
"version": "1.0.2",
"version": "1.0.3",
"description": "A robust Angular component that displays validation errors for form controls with advanced theming, localization, and analytics integration.",
"author": "Adinan Alhassan <[email protected]>",
"license": "MIT",
Expand Down

0 comments on commit 9cbc129

Please sign in to comment.