Create A Onboarding Screen Module for Angular Applications | ngx-onboarding

ngx-onboarding-library

ngx onboarding is a customizable built-in library for Angular that can be used to direct your visitors through your web application. The setup library gives you the ability to add a tutorial directly to your angular app.

angular onboarding library, onboarding js, onboarding screens, javascript onboarding library, onboarding screen android github, onboarding screen angular native

Features

  • Define multiple steps in each view.
  • Highlight each step.
  • Configurable in which position (top, bottom, left, or right) the info text should be displayed.
  • Multi-language support
  • If the setting is enabled, the buttons to go to the next step and to turn off the setting become visible.
  • If the user sees an onboard view, it will be stored by default in the browser’s local storage.
  • Possibility to reset and run setup again.

How to make use of it:

Installation:

# NPM
$ npm install @rosen-group/ngx-onboarding --save

1. Add a rosen-onboarding component anywhere to your main component, for example, app. component.

<rosen-onboarding></rosen-onboarding>

2. Add material icons reference to index.html.

<link href="//fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">

3. Add OnboardingModule and its dependencies to your module.

imports: [
       BrowserModule,
       BrowserAnimationsModule,
       HttpClientModule,
       MatIconModule,
       MatButtonModule,
       OnboardingModule
   ]

4. Add some styles, for example to app.component.css()

@import "[email protected]/material/prebuilt-themes/indigo-pink.css";

Property descriptions

PropertyTypeDefault valueDescription
selectorstringnullThe CSS selector, which identifies the html element you want to describe
groupstringnullGroups in the same view will be displayed together
positiontop / bottom / right / leftbottomPositioning of the headline and details
textAlignleft / right / centercenterAlignment of the headline and details
headlinestringnullHeadline text for a single onboarding item
detailsstringnullDetails text for a single onboarding item
descriptionsArraynullCollection of additional translations for headline and detail text
— languagestringnullLanguage key, e.g. en or de, related to your translation definition
— headlinestringnullTranslated headline text for a single onboarding item
— detailsstringnullTranslated details text for a single onboarding item

Create A Onboarding Screen On Your App, ngx-onboarding Plugin/Github, onboarding screen design


See Demo And Download

Official Website(rosen-group): Click Here

This superior jQuery/javascript plugin is developed by rosen-group. For extra Advanced Usages, please go to the official website.