react-interactive-tutorials
Advanced tools
Comparing version 0.1.2 to 0.1.3
@@ -347,3 +347,2 @@ (function webpackUniversalModuleDefinition(root, factory) { | ||
var reactClass = this; | ||
console.log('jquery resolved is', $ === _jquery2.default); | ||
(0, _jquery2.default)(document).on('shown.bs.dropdown', reactClass.refreshStep); | ||
@@ -350,0 +349,0 @@ (0, _jquery2.default)(document).on('hidden.bs.dropdown', reactClass.refreshStep); |
{ | ||
"name": "react-interactive-tutorials", | ||
"version": "0.1.2", | ||
"version": "0.1.3", | ||
"description": "Framework for creating unobtrusive interactive tutorials for use in web apps.", | ||
@@ -8,5 +8,11 @@ "main": "index.js", | ||
"test": "echo \"Error: no test specified\" && exit 1", | ||
"buildjs": "./node_modules/webpack/bin/webpack.js", | ||
"buildjs": "./node_modules/webpack/bin/webpack.js --config webpack.config.js", | ||
"buildjs-demo": "./node_modules/webpack/bin/webpack.js --config webpack.config.demo.js", | ||
"buildsass": "./node_modules/node-sass/bin/node-sass src/style.sass dist/interactive-tutorials.css", | ||
"prepublish": "npm run buildjs && npm run buildsass" | ||
"buildsass-demo": "./node_modules/node-sass/bin/node-sass src/style.sass dist/interactive-tutorials.css", | ||
"build": "npm run buildjs && npm run buildsass", | ||
"build-demo": "npm run buildjs-demo && npm run buildsass-demo", | ||
"prepublish": "npm run build" | ||
}, | ||
@@ -13,0 +19,0 @@ "repository": { |
# react-interactive-tutorials | ||
Framework for creating unobtrusive interactive tutorials for use in web apps. | ||
## Live Demo | ||
Have a play around with the live demo here: http://abasystems.github.io/react-interactive-tutorials/ | ||
## How it Works | ||
@@ -11,1 +14,44 @@ Tutorials are represented as a set of prompts that will result in the user successfully completing | ||
and do something unexpected / get lost in the middle of a tutorial without consequence. | ||
## Requirements | ||
To install, you will need: | ||
- Bootstrap 3 stylesheet, or an implementation of the used classes: | ||
- btn | ||
- btn-primary | ||
- btn-default | ||
- pull-right | ||
And anyone using your site will need: | ||
- A relatively modern browser | ||
- Javascript enabled | ||
- Cookies enabled | ||
## Installation | ||
Install the npm package: | ||
``` | ||
npm install react-interactive-tutorials | ||
``` | ||
Include the built css located at: | ||
``` | ||
node_modules/react-interactive-tutorials/dist/interactive-tutorials.css | ||
``` | ||
Register your own tutorials: | ||
```javascript | ||
// es6 | ||
import { registerTutorials } from 'react-interactive-tutorials' | ||
registerTutorials(YOUR_TUTORIALS); | ||
// attached to global var | ||
interactiveTutorials.registerTutorials(YOUR_TUTORIALS); | ||
``` | ||
## Making tutorials | ||
Full reference documentation coming soon. For now, take a look at the reference on the live demo at | ||
http://abasystems.github.io/react-interactive-tutorials/. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
90187
32
1944
57