@janarendvw/spotlight
Advanced tools
Comparing version 2.1.0 to 2.1.1
# @janaredvw/spotlight | ||
## 2.1.1 | ||
### Patch Changes | ||
- 1fa808f: added readme | ||
## 2.1.0 | ||
@@ -4,0 +10,0 @@ |
{ | ||
"name": "@janarendvw/spotlight", | ||
"license": "MIT", | ||
"version": "2.1.0", | ||
"version": "2.1.1", | ||
"description": "A simple spotlight effect for your web app", | ||
@@ -6,0 +6,0 @@ "keywords": [ |
# spotlight | ||
package that can be used to create quick spotlight-like tutorials for your web interfaces | ||
## installation | ||
#### npm | ||
`npm i @janarendvw/spotlight` | ||
#### yarn | ||
`yarn add @janarendvw/spotlight` | ||
#### pnpm | ||
`pnpm add @janarendvw/spotlight` | ||
## usage | ||
#### Add elements to the spotlight tour | ||
```html | ||
<div data-spotlight>{...}</div> | ||
``` | ||
#### Add a description to the element | ||
```html | ||
<div data-spotlight data-spotlight-description="This is a clickable div element.">{...}</div> | ||
``` | ||
#### Order your elements in the spotlight tour | ||
```html | ||
<div data-spotlight data-spotlight-order="1">{...}</div> | ||
<div data-spotlight data-spotlight-order="2">{...}</div> | ||
<div data-spotlight data-spotlight-order="3">{...}</div> | ||
``` | ||
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
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
54738
38