File size: 7,587 Bytes
4fb4c20 7cbaa45 4fb4c20 7cbaa45 4fb4c20 7cbaa45 4fb4c20 7cbaa45 4fb4c20 425e02a 42aa4be 425e02a 42aa4be 425e02a 42aa4be 425e02a 4fb4c20 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
---
title: "Popover Buttons"
groupTitle: "Examples"
sort: 9
---
import { CodeSample } from "../../components/CodeSample.tsx";
You can use the `showButtons` option to choose which buttons to show in the popover. The default value is `['next', 'previous', 'close']`.
<div id="driver-note" className="mb-5">
> **Note:** When using the `highlight` method to highlight a single element, the only button shown is the `close`
button. However, you can use the `showButtons` option to show other buttons as well. But the buttons won't do
anything. You will have to use the `onNextClick` and `onPreviousClick` callbacks to implement the functionality.
</div>
<div className='flex flex-col gap-1'>
<CodeSample
buttonText={"Show All Buttons"}
config={{
showButtons: [
'next',
'previous',
'close'
],
}}
tour={[
{
element: '#driver-note',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
},
{
element: '#driver-note p code:nth-child(4)',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
}
]}
id={"code-sample"}
client:load>
```js
import { driver } from "driver.js";
import "driver.js/dist/driver.css";
const driverObj = driver({
showButtons: [
'next',
'previous',
'close'
],
steps: [
{
element: '#first-element',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
},
{
element: '#second-element',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
}
]
});
driverObj.drive();
```
</CodeSample>
<CodeSample
buttonText="No Close Button"
config={{
showButtons: [
'next',
'previous',
],
}}
tour={[
{
element: '#driver-note',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
},
{
element: '#driver-note code:nth-child(2)',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
}
]}
id={"code-sample"}
client:load />
<CodeSample
buttonText="No Buttons (Use Arrows)"
config={{
showButtons: [undefined],
}}
tour={[
{
element: '#driver-note',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
},
{
element: '#driver-note code:nth-child(2)',
popover: {
title: 'Popover Title',
description: 'Popover Description',
side: 'bottom',
align: 'start'
}
}
]}
id={"code-sample"}
client:load />
</div>
## Change Button Text
You can also change the text of buttons using `nextBtnText`, `prevBtnText` and `doneBtnText` options.
<div className='flex flex-col gap-1'>
<CodeSample
heading="Change Button Text"
buttonText={"Change Button Text"}
config={{
showProgress: true,
nextBtnText: '—>',
prevBtnText: '<--',
doneBtnText: 'X',
}}
tour={[
{
element: '#code-sample-3',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
},
{
element: '#code-sample-3 code',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
}
]}
id={"code-sample-3"}
client:load>
```js
import { driver } from "driver.js";
import "driver.js/dist/driver.css";
const driverObj = driver({
nextBtnText: '—›',
prevBtnText: '‹—',
doneBtnText: '✕',
showProgress: true,
steps: [
// ...
]
});
driverObj.drive();
```
</CodeSample>
</div>
## Event Handlers
You can use the `onNextClick`, `onPreviousClick` and `onCloseClick` callbacks to implement custom functionality when the user clicks on the next and previous buttons.
> Please note that when you configure these callbacks, the default functionality of the buttons will be disabled. You will have to implement the functionality yourself.
<CodeSample
buttonText={"Show Example"}
config={{}}
tour={[
{
element: '#logger-events',
popover: {
title: 'Events Logged',
description: 'Look at your console for the events logged'
}
},
{
element: '#code-sample-4 code',
popover: {
title: 'Popover Title',
description: 'Popover Description'
}
}
]}
id={"logger-events"}
client:load>
```js
import { driver } from "driver.js";
import "driver.js/dist/driver.css";
const driverObj = driver({
onNextClick:() => {
console.log('Next Button Clicked');
// Implement your own functionality here
driverObj.moveNext();
},
onPrevClick:() => {
console.log('Previous Button Clicked');
// Implement your own functionality here
driverObj.movePrevious();
},
onCloseClick:() => {
console.log('Close Button Clicked');
// Implement your own functionality here
driverObj.destroy();
},
steps: [
// ...
]
});
driverObj.drive();
```
</CodeSample>
## Custom Buttons
You can add custom buttons using `onPopoverRender` callback. This callback is called before the popover is rendered. In the following example, we are adding a custom button that takes the user to the first step.
<CodeSample
buttonText={"Run Example"}
config={{
prevBtnText: '← Previous',
nextBtnText: 'Next →',
doneBtnText: 'Done',
showButtons: ['next', 'previous'],
}}
tour={[
{
element: '#demo-hook-theme',
popover: {
align: 'start',
side: 'left',
title: 'More Control with Hooks',
description: 'You can use onPopoverRender hook to modify the popover DOM. Here we are adding a custom button to the popover which takes the user to the first step.'
}
},
{
element: 'h1',
popover: {
align: 'start',
side: 'bottom',
title: 'Style However You Want',
description: 'You can use the default class names and override the styles or you can pass a custom class name to the popoverClass option either globally or per step.'
}
},
{
element: 'p a',
popover: {
align: 'start',
side: 'left',
title: 'Style However You Want',
description: 'You can use the default class names and override the styles or you can pass a custom class name to the popoverClass option either globally or per step.'
}
}
]}
id={"demo-hook-theme"}
client:load
>
```js
import { driver } from "driver.js";
import "driver.js/dist/driver.css";
const driverObj = driver({
// Get full control over the popover rendering.
// Here we are adding a custom button that takes
// user to the first step.
onPopoverRender: (popover, { config, state }) => {
const firstButton = document.createElement("button");
firstButton.innerText = "Go to First";
popover.footerButtons.appendChild(firstButton);
firstButton.addEventListener("click", () => {
driverObj.drive(0);
});
},
steps: [
// ..
]
});
driverObj.drive();
```
</CodeSample> |