intro.js README

The project's README from github.com/usablica/intro.js. As one markdown file: README.md.

Intro.js

Build Status npm

User Onboarding and Product Walkthrough Library

Where to get

You can obtain your local copy of Intro.js from:

1) This GitHub repository, using git clone https://github.com/usablica/intro.js.git

2) Using yarn yarn add intro.js

3) Using npm npm install intro.js --save

4) Download it from CDN (1, 2)

How to use

Intro.js can be added to your site in three simple steps:

1) Include intro.js and introjs.css (or the minified version for production) in your page. Use introjs-rtl.min.css for Right-to-Left language support.

CDN hosted files are available at jsDelivr (click Show More) & cdnjs.

2) Add data-intro and data-step to your HTML elements. To add hints you should use data-hint attribute.

For example:

<a href='http://google.com/' data-intro='Hello step one!'></a>

See all attributes here.

3) Call this JavaScript function:

introJs().start();

Optionally, pass one parameter to introJs function to limit the presentation section.

For example introJs(".introduction-farm").start(); runs the introduction only for elements with class='introduction-farm'.

Documentation

Please visit Documentation.

Using with:

Intro.js has many wrappers for different purposes. Please visit Documentation for more info.

Build

First you should install nodejs and npm, then first run this command: npm install to install all dependencies.

Now you can run this command to minify all static resources:

npm run build

Contributors ✨


Afshin Mehrabani

💻 📖

bozdoz

💻 📖

Support/Discussion

License

Commercial license

If you want to use Intro.js for a commercial application, theme or plugin the commercial license is the appropriate license. With this option, your source code is kept proprietary. Purchase a commercial license at introjs.com

Open-source license

GNU AGPLv3

intro.js (usablica/intro.js)

Searching Database…

23.5K ·GitHub
Что это такое?Intro.js — это лёгкая библиотека для знакомства пользователей с веб-продуктом: она добавляет пошаговые экскурсии-туры, которые показывают посетителям, как пользоваться сайтом или приложением.
Это облачный сервис или библиотека, которую я встраиваю в свои страницы?Библиотека для встраивания: это клиентская JavaScript-библиотека (написана на TypeScript), которая поставляется в виде одного файла intro.js плюс introjs.css — никаких сервисов и аккаунтов не нужно.
Как добавить тур на свой сайт?Установите через npm или yarn, либо возьмите с CDN (jsDelivr/cdnjs); подключите intro.js и introjs.css, пометьте нужные элементы атрибутами data-intro и data-step, затем вызовите introJs().start().
Нужно ли что-то особенное, чтобы это работало?Нет — библиотека работает в браузере без единой зависимости в рантайме: достаточно скрипта intro.js и его таблицы стилей. Node и npm нужны только для сборки из исходников.
Можно ли бесплатно использовать это в коммерческом проекте?Двойная лицензия: GNU AGPLv3 для open-source-использования, а для коммерческих приложений, тем или плагинов требуется платная коммерческая лицензия, которую покупают на introjs.com.
Могу ли я ограничить тур только одной частью страницы?Да — передайте селектор в introJs(): introJs('.introduction-farm').start() запустит экскурсию только для элементов с этим классом.
А есть что-то попроще, чем полноценный тур?Да, подсказки (hints): добавьте элементам атрибут data-hint, и на них появятся выноски с подсказками — отдельно от пошагового тура на основе data-intro/data-step.
Как насчёт языков с письмом справа налево?Поддерживаются — подключите introjs-rtl.min.css вместо стандартной таблицы стилей, и появится поддержка направления справа налево.
Есть ли готовые обёртки для фронтенд-фреймворков?В README сказано, что у Intro.js много обёрток для разных целей, и отсылает за подробностями к документации, не называя конкретные фреймворки.
Creator
usablica
Size
52.3 MB
Stars
23.5K
Age
13y
Commits · 90 Days