StepOptionsButton

Properties

action()?

optional action: (this) => void

A function executed when the button is clicked on It is automatically bound to the tour the step is associated with, so things like this.next will work inside the action. You can use action to skip steps or navigate to specific steps, with something like:

action() {
  return this.show('some_step_name');
}

Parameters

• this: Tour

Returns

void

Defined in

docs-src/node_modules/shepherd.js/src/step.ts:251

---

classes?

optional classes: string

Extra classes to apply to the <a>

Defined in

docs-src/node_modules/shepherd.js/src/step.ts:256

---

disabled?

optional disabled: boolean | () => boolean

Whether the button should be disabled When the value is true, or the function returns true the button will be disabled

Defined in

docs-src/node_modules/shepherd.js/src/step.ts:262

---

label?

optional label: StringOrStringFunction

The aria-label text of the button

Defined in

docs-src/node_modules/shepherd.js/src/step.ts:267

---

secondary?

optional secondary: boolean

A boolean, that when true, adds a shepherd-button-secondary class to the button.

Defined in

docs-src/node_modules/shepherd.js/src/step.ts:272

---

text?

optional text: StringOrStringFunction

The HTML text of the button

Defined in

docs-src/node_modules/shepherd.js/src/step.ts:277