Comparing version
{ | ||
"name": "ajala.js", | ||
"private": false, | ||
"version": "0.4.0", | ||
"version": "0.4.1", | ||
"type": "module", | ||
@@ -6,0 +6,0 @@ "main": "./dist/ajala.cjs", |
@@ -1,3 +0,1 @@ | ||
<!-- @format --> | ||
# Àjàlá.js | ||
@@ -60,10 +58,6 @@ | ||
**Please note:** You only need to import `import "ajala.js/dist/ajala.css";` if you are using the default tooltip provided by Ajala. If you choose to provide your own custom tooltip, you can skip this import. | ||
**Please note:** That you only need `import "ajala.js/dist/ajala.css";` when you are using ajala default tooltip, you don't need it if you provide your own custom tooltip | ||
The `AjalaJourney` class accept two arguments: | ||
`AjalaJourney` class accept two arguments, an array of steps object which is compulsory and the journey options that's used to customize the jounery experience globally. | ||
1. **Steps Array:** This is a required array of step objects that define the individual steps in the walkthrough journey. | ||
2. **Journey Options:** These are used to globally customize the walkthrough journey experience, allowing you to adjust settings like appearance, behavior, and other configurations. | ||
## Ajala Step Shape | ||
@@ -92,2 +86,4 @@ | ||
| tooltip_placement | `top_left`, `top_center`, `top_right`, `bottom_left`, `bottom_center`, `bottom_right`, `left_top`, `left_bottom`, `left_center`, `right_top`, `right_bottom`, `right_center`, `auto` | This helps customize where the tooltip should be placed on the spotlight element. Default value is `auto` which means ajala calculate the best placement for the tooltip. Please note that if you pass a value aside `auto` and ajala discover that the tooltip will be out-of-user-view, ajala will fallback to `auto` for optimal user experience. | | ||
| onActive | function | Callback function that's called when the step is active, active here means it's the step currently being highlighted | | ||
| onInActive | function | Callback function that's called when the step is no longer active, | | ||
@@ -94,0 +90,0 @@ ## Responsive Ajala Step |
126067
0.7%277
-1.42%