ShepherdModalAPI
Defined in: components/shepherd-modal.ts:37
Controls the overlay behind a tour. Reached through tour.modal.
Properties
Section titled “Properties”closeModalOpening
Section titled “closeModalOpening”closeModalOpening: () =>
void
Defined in: components/shepherd-modal.ts:41
Removes the opening, so the overlay covers the whole page.
Returns
Section titled “Returns”void
destroy
Section titled “destroy”destroy: () =>
void
Defined in: components/shepherd-modal.ts:45
Removes the overlay from the DOM.
Returns
Section titled “Returns”void
getElement
Section titled “getElement”getElement: () =>
SVGElement
Defined in: components/shepherd-modal.ts:74
Returns the overlay’s <svg> element.
Returns
Section titled “Returns”SVGElement
hide: () =>
void
Defined in: components/shepherd-modal.ts:49
Hides the overlay.
Returns
Section titled “Returns”void
positionModal
Section titled “positionModal”positionModal: (
modalOverlayOpeningPadding?,modalOverlayOpeningRadius?,modalOverlayOpeningXOffset?,modalOverlayOpeningYOffset?,targetScrollParent?,targetElement?,extraHighlights?) =>void
Defined in: components/shepherd-modal.ts:53
Moves the opening to the given target and extra highlights.
Parameters
Section titled “Parameters”modalOverlayOpeningPadding?
Section titled “modalOverlayOpeningPadding?”number
modalOverlayOpeningRadius?
Section titled “modalOverlayOpeningRadius?”modalOverlayOpeningXOffset?
Section titled “modalOverlayOpeningXOffset?”number
modalOverlayOpeningYOffset?
Section titled “modalOverlayOpeningYOffset?”number
targetScrollParent?
Section titled “targetScrollParent?”HTMLElement | null
targetElement?
Section titled “targetElement?”HTMLElement | null
extraHighlights?
Section titled “extraHighlights?”HTMLElement[]
Returns
Section titled “Returns”void
setupForStep
Section titled “setupForStep”setupForStep: (
step) =>void
Defined in: components/shepherd-modal.ts:66
Shows the overlay and keeps its opening on the step’s target, or hides the
overlay when the tour does not use useModalOverlay.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
show: () =>
void
Defined in: components/shepherd-modal.ts:70
Shows the overlay.
Returns
Section titled “Returns”void