Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(ngx-inform): split introduction page into sections for different audiences #403

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(ngx-inform): split introduction page into sections for different audiences #403

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions apps/docs/src/app/pages/docs/angular/inform/introduction/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,18 @@
keyword: IntroductionPage
---

`ngx-inform` is a collection of Angular flows related to informing end-users.
## For Organisations

`ngx-inform` is a package to help facilitate common user information use-cases such as tooltips, toasts and snackbars.
In modern web applications, effectively communicating with users is crucial. The `@studiohyperdrive/ngx-inform` package provides a comprehensive solution for user notifications and interactions. It helps organisations by:

- **Enhanced User Experience**: Provides clear and consistent ways to communicate with users through tooltips, modals, and notifications
- **Accessibility Compliance**: Ensures all notification components are WCAG compliant, making your application accessible to all users
- **Reduced Development Effort**: Offers ready-to-use, tested components for common notification patterns
- **Consistent Communication**: Standardizes how your application communicates with users across different features
- **Flexible Integration**: Easily adapts to your application's design system and requirements
- **Improved User Guidance**: Helps users understand complex features through tooltips and contextual help

## For Developers

At its core, `ngx-inform` is build to be WCAG and ARIA compliant, and will throw errors whenever the necessary setup has not been provided to ensure said compliancy.

Expand Down