introjs 1.0.0

  • README.md
  • changelog.md
  • Installing
  • Versions
  • 45

introjs.dart v1.0.0

A dart wrapper for intro.js v2.3.0.

Check the original repo's README for more info.

pubspec.yaml

...
dependencies:
    inrojs: ^1.0.0
...

How to use

This Dart package includes the original intro.js in it so you can include it from your packages once you've run pub get:

<link href="packages/introjs/introjs.css" rel="stylesheet">
<script type="text/javascript" src="packages/introjs/intro.js"></script>

<script type="application/dart" src="myapp.dart"></script>

The minified js scripts are under the minified directory:

<link href="packages/introjs/minified/introjs.min.css" rel="stylesheet">
<script type="text/javascript" src="packages/introjs/minified/intro.min.js"></script>

<script type="application/dart" src="myapp.dart"></script>

Add all the data-intros and data-steps to your HTML elements (see original README and documentation for more details) and then in myapp.dart:

import "package:introjs/introjs.dart";

void main() {
  new IntroJs().start();
}

Examples

Examples for using the Dart wrapper can be found in the example directory.

Release History

  • v2.3.0 - 2016-07-01

    • Fixing the conflict with Bootstrap 3
    • Adding two new options to hide next and previous button in first and last steps
    • Add web components compatibility (polymer)
    • Removing position: absolute from parent fix class
    • Fixing typo in hint pulse class
    • Adding a Bootstrap 3 example + different positions example
    • and some minor bug fixes.
  • v2.1.0 - 2016-04-20

    • Removed javascript:void hrefs in order to support CSP
    • Add hideHint function to public api
    • Add re-align hints to refresh function + skip hidden elements for intro
    • Added a check for ghost elements
    • Remove introjs-fixedTooltip if not needed
    • Removed any leftover introjs-fixedTooltip class
    • CSS - Make filter a string
    • Add new template 'flattener'
    • Updating documentation + adding Emberjs
    • and some minor bug fixes.
  • v2.0.0 - 2015-12-21

    • Adding hint feature
    • Updating templates
  • v1.1.1 - 2015-09-05

    • Fix versioning issue
  • v1.1.0 - 2015-09-01

    • Fix no interaction bug
    • Fix recursion bug with jQuery
    • Call onexit on pressing Esc or clicking on the overlay layer
    • Fix helper layer positioning issue when the content changes
    • Fix transform is 'undefined' in IE 8
    • Fix coding style issues
  • v1.0.0 - 2014-10-17

    • Auto-positioning feature for tooltip box
    • Add progress-bar to tooltip box
    • Fix z-index issue
    • Add dark template
    • Fix bad sizing with Bootstrap 3
    • Add disable interaction ability
    • Fix code styling issues and many minor bug fixes
  • v0.9.0 - 2014-05-23

    • Add IntroJS templates
    • Add more tooltip positions (bottom-right, bottom-middle, bottom-left)
    • Fix table tr element's issue
  • v0.8.0 - 2014-03-25

    • Ability to define introductions without focusing on elements
    • Fix Internet Explorer 8.0 issue
    • Add _direction property
  • v0.7.1 - 2014-03-11

    • Fix "Too much recursion" issue with Firefox and Internet Explorer.
  • v0.7.0 - 2014-02-07

    • Add onafterchange event
    • Add scrolling to element option
    • Add nextStep and previousStep functions publicly
    • Add _cloneObject method to prevent data overwriting
    • Fix null elements problem with programmatic definition
    • Fix issues with single-step introductions
    • Fix top margin problem on hidden elements
    • Fix stacking context problem caused by element opacity
    • Fix call exit() on null elements
    • Update documentation and add more details on CDN servers and RTL example
  • v0.6.0 - 2013-11-13

    • Add step bullets with navigating
    • Add option to hide introduction navigating buttons
    • Make keyboard navigation optional
    • Making data-step optional with elements
    • Fix scroll issue when scrolling down to elements bigger than window
    • Fix Chrome version 30.0.1599.101 issue with hiding step numbers
    • Fix incorrect calling onExit callback when user clicks on overlay layer
    • Fix coding styles and improvement in performance
  • v0.5.0 - 2013-07-19

    • Add CSS class option for tooltips (And tooltip buttons also)
    • Add RTL version
    • Ability to add HTML codes in tooltip content
    • Ability to add DOM object and CSS selector in programmatic API (So you can use jQuery selector engine)
    • Add refresh() method to refresh and order layers manually
    • Show tooltip buttons only when introduction steps are more than one
    • Fix onbeforechange event bug and pass correct object in parameters
    • Fix Null element exception in some browsers
    • And add more examples
  • v0.4.0 - 2013-05-20

    • Add multi-page introduction example
    • Add programmatic introduction definition
    • Cooler introduction background!
    • Remove IE specific css file and embed IE support to main css file (property fallback)
    • Update introduction position on window resize (Also support tablet/mobile devices rotation)
    • Disable buttons on the first and start of introduction (Skip and Done button)
    • Add onbeforechange callback
    • Add showStepNumbers option to show/hide step numbers
    • Add exitOnEsc and exitOnOverlayClick options
    • Fix bad tooltip position calculating problem
    • Fix a bug when using !important in element css properties
    • Fix a bug in onexit behavior
    • Code refactoring
  • v0.3.0 - 2013-03-28

    • Adding support for CommonJS, RequireJS AMD and Browser Globals.
    • Add goToStep function to go to specific step of introduction.
    • Add onchange callback.
    • Add exit function to exit from introduction.
    • Adding options with setOption and setOptions functions.
    • More IE compatibility.
    • Fix min-width bug with tooltip box.
    • Code cleanup + Better coding style.
  • v0.2.1 - 2013-03-20

    • Fix keydown event unbinding bug.
  • v0.2.0 - 2013-03-20

    • Ability to define tooltip position with data-position attribute
    • Add onexit and oncomplete callback
    • Better scrolling functionality
    • Redesign navigating buttons + add previous button
    • Fix overlay layer bug in wide monitors
    • Fix show element for elements with position absolute or relative
    • Add enter key for navigating in steps
    • Code refactoring
  • v0.1.0 - 2013-03-16
    • First commit.

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  introjs: "^1.0.0"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:introjs/introjs.dart';
        
Version Uploaded Documentation Archive
1.0.0 Oct 26, 2016 Go to the documentation of introjs 1.0.0 Download introjs 1.0.0 archive

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
73 / 100
Overall score:
Weighted score of the above. [more]
45

Platforms

Detected platforms: web

Primary library: package:introjs/introjs.dart with components: html, js.

Suggestions

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Maintain an example.

    None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use introjs.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.13.1 <2.0.0
js ^0.6.0 0.6.1
Dev dependencies
browser any