Skip to content

docs(tour): add organisations section to introduction -- closes #311 #404

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
84 changes: 83 additions & 1 deletion apps/docs/src/app/pages/docs/angular/tour/introduction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,88 @@
keyword: IntroductionPage
---

`ngx-tour` is light-weight and heavily customizable package to create a help tour through an application using [the CDK overlay](https://material.angular.io/cdk/overlay/overview).
`ngx-tour` is an Angular based package providing accessible and user-friendly application tours.

## For organisations

In complex web applications, user onboarding and feature discovery are crucial for adoption and user satisfaction. Our tour package provides an accessible way to guide users through your application's features and workflows, ensuring they get the most value from your software.

By implementing WCAG compliant interactive tours, we help organizations make their applications more accessible and user-friendly. Our solution ensures that all users, regardless of their abilities, can effectively learn and navigate your application's features.

We also focus on making tours adaptable to different user roles and permissions, allowing you to create targeted guidance for different user groups. This personalized approach helps reduce support costs and improves user engagement.

Our package helps organisations by providing:

- **Accessibility Compliance**: Fully WCAG compliant tour implementations
- **User Engagement**: Interactive guidance through complex features
- **Reduced Support Costs**: Self-service user onboarding and training
- **Flexible Implementation**: Tours adaptable to different user roles
- **Better User Adoption**: Clear guidance for new features and workflows
- **Consistent Experience**: Standardized tour behavior across your application

Looking for more information on how this package can help you out in your application? Mail us at [[email protected]](mailto:[email protected])

## For developers

The `ngx-tour` package provides a comprehensive solution for implementing interactive application tours. It handles everything from step management to accessibility requirements.

With the tour approach of `ngx-tour`, we aim to create a very light-weight bare bones approach to the help tours. The package requires the user to provide their own styling and components for the steps shown during the tour, ensuring a maximized customizability.

Here's what you can do with our tour system:

### Tour Configuration

```typescript
// Define tour steps
const tourSteps: TourStep[] = [
{
target: '#welcome-section',
title: 'Welcome to our app',
content: 'Let us show you around!',
placement: 'bottom'
},
{
target: '.feature-button',
title: 'Key Features',
content: 'Click here to access main features',
placement: 'right'
}
];

// Initialize tour
constructor(private tourService: NgxTourService) {
this.tourService.initialize(tourSteps);
}
```

### Tour Control

```typescript
// Start the tour
this.tourService.start();

// Navigate through steps
this.tourService.next();
this.tourService.previous();

// Handle tour events
this.tourService.onStepChange.subscribe(step => {
console.log('Current step:', step);
});
```

### Accessibility Features

```typescript
@Component({
template: `
<ngx-tour-step
[step]="currentStep"
[ariaLabel]="'Tour step ' + (currentStep.index + 1)"
[focusOnShow]="true"
(keydown.escape)="tourService.end()">
{{ currentStep.content }}
</ngx-tour-step>
`
})
```