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.
### Popover on Highlighted Element – [Demo](http://kamranahmed.info/driver#single-element-with-popover)
### Highlight and Popover – [Demo](http://kamranahmed.info/driver#single-element-with-popover)
You can show additional details beside the highlighted element using the popover
...
...
@@ -82,6 +87,8 @@ driver.highlight({
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
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
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
constdriver=newDriver();
...
...
@@ -136,4 +145,79 @@ driver.defineSteps([
// Start the introduction
driver.start();
```
You can also hide the buttons and control the introductions programmatically by using the API methods listed below
# 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
constdriver=newDriver({
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
conststepDefinition={
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
}
};
```
### API Methods
Below are the set of methods that are available to you
```javascript
constdriver=newDriver(driverOptions);
constisActivated=driver.isActivated;// Checks if the driver is active or not
driver.moveNext();// Moves to next step in the steps list
driver.movePrevious();// Moves to previous step in the steps list
driver.start(stepNumber=0);// Starts driving through the defined steps
driver.highlight(string|stepDefinition);// highlights the element using query selector or the step definition
driver.reset();// Resets the overlay and clears the screen
driver.hasHighlightedElement();// Checks if there is any highlighted element
driver.hasNextStep();// Checks if there is next step to move to
driver.hasPreviousStep();// Checks if there is previous step to move to
// Gets the currently highlighted element on screen
