Merge branch 'master' of github.com:kamranahmedse/driver.js

readme.md

@@ -1,11 +1,11 @@
 <h1 align="center"><img src="./demo/images/driver.png" /><br> Driver.js</h1>
 
 <p align="center">
-  <a href="https://creativecommons.org/licenses/by/4.0/">
-    <img src="https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg" />
+  <a href="https://github.com/kamranahmedse/driver.js/blob/master/license">
+    <img src="https://img.shields.io/github/license/kamranahmedse/driver.js.svg" />
   </a>
-  <a href="http://makeapullrequest.com">
-    <img src="https://img.shields.io/badge/contributions-welcome-green.svg" />
+  <a href="https://npmjs.org/package/driver.js">
+    <img src="https://img.shields.io/npm/v/driver.js.svg" alt="version" />
   </a>
   <a href="http://twitter.com/kamranahmedse">
     <img src="https://img.shields.io/badge/author-kamranahmedse-blue.svg" />
@@ -23,7 +23,7 @@
 * **Light-weight**: ~4kb in size, vanilla JavaScript and no external dependency
 * **Highly customizable**: has a powerful API and can be used however you want
 * **Highlight anything**: highlight any (literally any) element on page
-* **Feature introductions**: create powerful feature introductions and onboarding strategies
+* **Feature introductions**: create powerful feature introductions for your web applications
 * **Focus shifters**: add focus shifters for users
 * **User friendly**: Everything is controllable by keyboard
 * **Consistent behavior**: usable across all browsers (including in-famous IE)
@@ -47,4 +47,221 @@ Or grab the code from `dist` directory and include it directly
 ```html
 <link rel="stylesheet" href="/dist/driver.min.css">
 <script src="/dist/driver.min.js"></script>
-```
+```
+
+![](./demo/images/split.png)
+
+## Usage and Demo
+
+Demos and many more usage examples can be found [through the docs page](http://kamranahmed.info/driver).
+
+### Highlighting Single Element – [Demo](http://kamranahmed.info/driver#single-element-no-popover)
+
+If all you want is just highlight a single element, you can do that simply by passing the selector
+
+```javascript
+const driver = new Driver();
+driver.highlight('#create-post');
+```
+A real world usage example for this could be using it to dim the background and highlight the required element e.g. the way facebook does it on creating a post.
+
+### Highlight and Popover – [Demo](http://kamranahmed.info/driver#single-element-with-popover)
+
+You can show additional details beside the highlighted element using the popover
+
+```javascript
+const driver = new Driver();
+driver.highlight({
+  element: '#some-element',
+  popover: {
+    title: 'Title for the Popover',
+    description: 'Description for it',
+  }
+});
+```
+
+Also, `title` and `description` can have HTML as well.
+
+### Positioning the Popover – [Demo](http://kamranahmed.info/driver#single-element-with-popover-position)
+
+By default, driver automatically finds the suitable position for the popover and displays it, you can override it using `position` property
+
+```javascript
+const driver = new Driver();
+driver.highlight({
+  element: '#some-element',
+  popover: {
+    title: 'Title for the Popover',
+    description: 'Description for it',
+    position: 'left', // can be `top`, `left`, `right`, `bottom`
+  }
+});
+```
+
+### Creating Feature Introductions – [Demo](http://kamranahmed.info/driver)
+
+Feature introductions are helpful in onboarding new users and giving them idea about different parts of the application, you can create them seemlessly with driver. Define the steps and call the `start` when you want to start presenting. User will be able to control the steps using keyboard or using the buttons on popovers.
+
+```javascript
+const driver = new Driver();
+
+// Define the steps for introduction
+driver.defineSteps([
+  {
+    element: '#first-element-introduction',
+    popover: {
+      title: 'Title on Popover',
+      description: 'Body of the popover',
+      position: 'left'
+    }
+  },
+  {
+    element: '#second-element-introduction',
+    popover: {
+      title: 'Title on Popover',
+      description: 'Body of the popover',
+      position: 'top'
+    }
+  },
+  {
+    element: '#third-element-introduction',
+    popover: {
+      title: 'Title on Popover',
+      description: 'Body of the popover',
+      position: 'right'
+    }
+  },
+]);
+
+// Start the introduction
+driver.start();
+```
+You can also hide the buttons and control the introductions programmatically by using the API methods listed below
+
+![](./demo/images/split.png)
+
+## API
+
+Driver comes with several options that you can manipulate to make driver behave as you may like
+
+### Driver Definition
+
+Here are the options that Driver understands
+
+```javascript
+const driver = new Driver({
+  animate: true,                    // Animate while changing highlighted element
+  opacity: 0.75,                    // Background opacity (0 means only popovers and without overlay)
+  padding: 10,                      // Distance of element from around the edges
+  onHighlightStarted: (Element) {}, // Called when element is about to be highlighted
+  onHighlighted: (Element) {},      // Called when element is fully highlighted
+  onDeselected: (Element) {},       // Called when element has been deselected
+});
+```
+
+### Step Definition
+
+Here are the set of options that you can pass while defining steps `defineSteps` or the object that you pass to `highlight` method
+
+```javascript
+const stepDefinition = {
+  element: '#some-item',        // Query selector for the item to be highlighted
+  popover: {                    // There will be no popover if empty or not given
+    title: 'Title',             // Title on the popover
+    description: 'Description', // Body of the popover
+    showButtons: false,         // Do not show control buttons in footer
+    doneBtnText: 'Done',        // Text on the last button
+    closeBtnText: 'Close',      // Text on the close button
+    nextBtnText: 'Next',        // Next button text
+    prevBtnText: 'Previous',    // Previous button text
+  }
+};
+```
+
+For example, here is how it would look when highlighting a single element
+
+```javascript
+const driver = new Driver(driverOptions);
+driver.highlight(stepDefinition);
+```
+
+And this is how it would look when creating a step by step guide
+
+```javascript
+const driver = new Driver(driverOptions);
+driver.defineSteps([
+    stepDefinition1,
+    stepDefinition2,
+    stepDefinition3,
+    stepDefinition4,
+]);
+```
+
+### API Methods
+
+Below are the set of methods that are available to you
+
+```javascript
+const driver = new Driver(driverOptions);
+
+// Checks if the driver is active or not
+if (driver.isActivated) {
+    console.log('Driver is active');
+}
+
+// In case of the steps guide, you can call below methods
+driver.defineSteps([ stepDefinition1, stepDefinition2, stepDefinition3 ]);
+driver.start(stepNumber = 0);  // Starts driving through the defined steps
+driver.moveNext();             // Moves to next step in the steps list
+driver.movePrevious();         // Moves to previous step in the steps list
+driver.hasNextStep();          // Checks if there is next step to move to
+driver.hasPreviousStep();      // Checks if there is previous step to move to
+
+// Highlights the element using query selector or the step definition
+driver.highlight(string|stepDefinition);
+
+// Resets the overlay and clears the screen
+driver.reset();
+
+// Checks if there is any highlighted element
+if(driver.hasHighlightedElement()) {
+    console.log('There is an element highlighted');
+}
+
+// Gets the currently highlighted element on screen
+// It would be an instance of `/src/core/element.js`
+const activeElement = driver.getHighlightedElement();
+
+// Gets the last highlighted element, would be an instance of `/src/core/element.js`
+const lastActiveElement = driver.getLastHighlightedElement();
+
+activeElement.getScreenCoordinates(); // Gets screen co-ordinates of the active element
+activeElement.hidePopover();          // Hide the popover
+activeElement.showPopover();          // Show the popover
+
+activeElement.getNode();  // Gets the DOM Element behind this element
+```
+
+![](./demo/images/split.png)
+
+## Todo
+
+- [X] Single elment highlighting
+- [X] Popovers on the highlighted elements
+- [X] Add smooth transition on changing highlighted elements
+- [X] Multi-step Journey Definitions
+- [X] Make it controllable by keyboard
+- [X] Bring highlighted element to viewport
+- [ ] Add type definitions
+- [ ] Create wrappers for Angular and React
+- [ ] Write tests
+
+## Contributions
+
+Feel free to submit pull requests, create issues or spread the word
+
+## License
+
+MIT &copy; [Kamran Ahmed](https://twitter.com/kamranahmedse)
+
+