MCPcopy Index your code

hub / github.com/shipshapecode/shepherd / functions

Functions151 in github.com/shipshapecode/shepherd

↓ 84 callersMethodstart
* Start the tour
shepherd.js/src/tour.ts:350
↓ 34 callersMethodgetCurrentStep
* Gets the current step
shepherd.js/src/tour.ts:253
↓ 33 callersMethodgetElement
* Returns the element for the step * @return {HTMLElement|null|undefined} The element instance. undefined if it has never been shown, null if it ha
shepherd.js/src/step.ts:554
↓ 31 callersMethodaddStep
* Adds a new step to the tour * @param {StepOptions} options - An object containing step options or a Step instance * @param {number | undefined
shepherd.js/src/tour.ts:165
↓ 26 callersMethodnext
* Go to the next step in the tour * If we are at the end, call `complete`
shepherd.js/src/tour.ts:279
↓ 24 callersFunctioncreateShepherdButton
( config: StepOptionsButton, step: Step )
shepherd.js/src/components/shepherd-button.ts:13
↓ 23 callersFunctioncreateShepherdModal
(container: HTMLElement)
shepherd.js/src/components/shepherd-modal.ts:48
↓ 22 callersMethodon
* Adds an event listener for the given event string. * * @param {string} event * @param {Function} handler * @param ctx * @param {boole
shepherd.js/src/evented.ts:22
↓ 20 callersMethodcomplete
* Calls _done() triggering the `complete` event
shepherd.js/src/tour.ts:235
↓ 20 callersMethodtrigger
(event: string, ...args: any[])
shepherd.js/src/evented.ts:78
↓ 17 callersMethodshow
* Show a specific step in the tour * @param {number | string} key - The key to look up the step by * @param {boolean} forward - True if we are g
shepherd.js/src/tour.ts:323
↓ 16 callersMethodhide
* Hide the current step
shepherd.js/src/tour.ts:260
↓ 15 callersFunctioncreateShepherdElement
( options: ShepherdElementOptions )
shepherd.js/src/components/shepherd-element.ts:24
↓ 14 callersFunctioncleanup
()
shepherd.js/src/components/shepherd-element.ts:179
↓ 13 callersFunctionisUndefined
(value: T | undefined)
shepherd.js/src/utils/type-check.ts:37
↓ 12 callersFunctionfireKeyDown
(el, keyCode, opts = {})
shepherd.js/test/unit/components/shepherd-element.spec.js:6
↓ 11 callersMethodcancel
* Calls _done() triggering the 'cancel' event * If `confirmCancel` is true, will show a window.confirm before cancelling * If `confirmCancel` is
shepherd.js/src/tour.ts:211
↓ 11 callersMethoddestroy
* Remove the step, delete the step's element, and destroy the FloatingUI instance for the step. * Triggers `destroy` event
shepherd.js/src/step.ts:430
↓ 10 callersFunctioncreateShepherdHeader
(labelId: string, step: Step)
shepherd.js/src/components/shepherd-header.ts:7
↓ 10 callersFunctionh
( tag: string, attrs?: Attrs | null, ...children: Child[] )
shepherd.js/src/utils/dom.ts:9
↓ 8 callersFunctionisFunction
(value: T | Function)
shepherd.js/src/utils/type-check.ts:21
↓ 8 callersFunctionsetupTooltip
(step: Step)
shepherd.js/src/utils/floating-ui.ts:24
↓ 8 callersFunctionshouldCenterStep
(resolvedAttachToOptions: StepOptionsAttachTo)
shepherd.js/src/utils/general.ts:82
↓ 7 callersMethod_getResolvedAttachToOptions
* A selector for resolved attachTo options. * @returns {{}|{element, on}} * @private
shepherd.js/src/step.ts:505
↓ 7 callersMethod_resolveAttachToOptions
* Resolves attachTo options. * @returns {{}|{element, on}}
shepherd.js/src/step.ts:495
↓ 7 callersMethodback
* Go to the previous step in the tour
shepherd.js/src/tour.ts:200
↓ 6 callersMethodgetById
* Gets the step from a given id * @param {number | string} id - The id of the step to retrieve * @return The step corresponding to the `id`
shepherd.js/src/tour.ts:244
↓ 6 callersFunctionisHTMLElement
(value: T | HTMLElement)
shepherd.js/src/utils/type-check.ts:13
↓ 6 callersMethodisOpen
* Check if the step is open and visible * @return True if the step is open and visible
shepherd.js/src/step.ts:517
↓ 5 callersMethod_scrollTo
* If a custom scrollToHandler is defined, call that, otherwise do the generic * scrollIntoView call. * * @param {boolean | ScrollIntoViewOpti
shepherd.js/src/step.ts:628
↓ 5 callersFunctionbindAdvance
(step: Step)
shepherd.js/src/utils/bind.ts:29
↓ 5 callersFunctioncreateShepherdContent
( descriptionId: string, labelId: string, step: Step )
shepherd.js/src/components/shepherd-content.ts:9
↓ 5 callersFunctioncreateShepherdText
( descriptionId: string, step: Step )
shepherd.js/src/components/shepherd-text.ts:6
↓ 5 callersFunctionparseAttachTo
(step: Step)
shepherd.js/src/utils/general.ts:37
↓ 5 callersFunctionparseExtraHighlights
(step: Step)
shepherd.js/src/utils/general.ts:69
↓ 5 callersMethodupdateStepOptions
* Updates the options of the step. * * @param {StepOptions} options The options for the step
shepherd.js/src/step.ts:538
↓ 4 callersMethod_setupElements
* Create the element and set up the FloatingUI instance * @private
shepherd.js/src/step.ts:701
↓ 4 callersFunctioncreateShepherdFooter
(step: Step)
shepherd.js/src/components/shepherd-footer.ts:6
↓ 4 callersMethodisActive
* Check if the tour is active
shepherd.js/src/tour.ts:271
↓ 4 callersFunctionisString
(value: T | string)
shepherd.js/src/utils/type-check.ts:29
↓ 3 callersFunction_cleanupStepEventListeners
()
shepherd.js/src/components/shepherd-modal.ts:192
↓ 3 callersMethod_done
* Called whenever the tour is cancelled or completed, basically anytime we exit the tour * @param {string} event - The event name to trigger * @
shepherd.js/src/tour.ts:369
↓ 3 callersFunction_updatePath
()
shepherd.js/src/components/shepherd-modal.ts:69
↓ 3 callersMethodaddSteps
* Add multiple steps to the tour * @param {Array<StepOptions> | Array<Step> | undefined} steps - The steps to add to the tour
shepherd.js/src/tour.ts:187
↓ 3 callersFunctionautoBind
(self: any)
shepherd.js/src/utils/auto-bind.ts:8
↓ 3 callersFunctioncreateShepherdTitle
( labelId: string, title: StringOrStringFunction )
shepherd.js/src/components/shepherd-title.ts:6
↓ 3 callersFunctiongetConfigOption
(option: unknown, step: Step)
shepherd.js/src/components/shepherd-button.ts:6
↓ 3 callersFunctiongetFloatingUIOptions
( attachToOptions: StepOptionsAttachTo, step: Step )
shepherd.js/src/utils/floating-ui.ts:171
↓ 3 callersMethodoff
* Removes an event listener for the given event string. * * @param {string} event * @param {Function} handler * @returns
shepherd.js/src/evented.ts:53
↓ 2 callersMethod_createTooltipContent
* Creates Shepherd element for step based on options * * @return {HTMLElement} The DOM element for the step tooltip * @private
shepherd.js/src/step.ts:603
↓ 2 callersFunction_getVisibleHeight
( el: HTMLElement, scrollParent?: HTMLElement | null )
shepherd.js/src/components/shepherd-modal.ts:272
↓ 2 callersMethod_setupActiveTour
* Make this tour "active"
shepherd.js/src/tour.ts:402
↓ 2 callersMethod_show
* Triggers `before-show`, generates the tooltip DOM content, * sets up a FloatingUI instance for the tooltip, then triggers `show`. * @private
shepherd.js/src/step.ts:722
↓ 2 callersMethod_teardownElements
* Internal cleanup that tears down the tooltip, component, and DOM element * without emitting the public "destroy" event. * @private
shepherd.js/src/step.ts:440
↓ 2 callersMethod_updateStepTargetOnHide
* When a step is hidden, remove the highlightClass and 'shepherd-enabled' * and 'shepherd-target' classes * @private
shepherd.js/src/step.ts:809
↓ 2 callersFunctionappendChildren
(el: Element, children: Child[])
shepherd.js/src/utils/dom.ts:50
↓ 2 callersFunctionapplyAttrs
(el: Element, attrs?: Attrs | null)
shepherd.js/src/utils/dom.ts:34
↓ 2 callersFunctioncleanupSteps
(tour: Tour)
shepherd.js/src/utils/cleanup.ts:8
↓ 2 callersFunctionnormalizePrefix
(prefix?: string)
shepherd.js/src/utils/general.ts:22
↓ 2 callersMethodremoveStep
* Removes the step from the tour * @param {string} name - The id for the step to remove
shepherd.js/src/tour.ts:293
↓ 2 callersMethodsetupModal
* setupModal create the modal container and instance
shepherd.js/src/tour.ts:411
↓ 2 callersFunctionsvgEl
( tag: string, attrs?: Attrs | null, ...children: Child[] )
shepherd.js/src/utils/dom.ts:23
↓ 2 callersFunctiont
(e)
shepherd.js/dummy/js/prism.js:8
↓ 2 callersFunctiont
(e)
shepherd.js/dev/js/prism.js:8
↓ 2 callersFunctiont
(e)
shepherd.js/test/cypress/dummy/js/prism.js:529
↓ 2 callersFunctionuuid
()
shepherd.js/src/utils/general.ts:96
↓ 1 callersFunction_addStepEventListeners
()
shepherd.js/src/components/shepherd-modal.ts:186
↓ 1 callersMethod_getClassOptions
* _getClassOptions gets all possible classes for the step * @param {StepOptions} stepOptions The step specific options * @returns {string} uniqu
shepherd.js/src/step.ts:646
↓ 1 callersFunction_getIframeOffset
(el?: HTMLElement | null)
shepherd.js/src/components/shepherd-modal.ts:246
↓ 1 callersFunction_getScrollParent
(el?: HTMLElement | null)
shepherd.js/src/components/shepherd-modal.ts:232
↓ 1 callersMethod_resolveExtraHiglightElements
* Resolves attachTo options. * @returns {{}|{element, on}}
shepherd.js/src/step.ts:486
↓ 1 callersMethod_restoreOriginalTabIndexes
* Restores the original tabIndex values for all elements that were modified during the tour. * If an element is in the map, restores its original v
shepherd.js/src/step.ts:586
↓ 1 callersMethod_setOptions
* Sets the options for the step, maps `when` to events, sets up buttons * @param options - The options for the step
shepherd.js/src/step.ts:667
↓ 1 callersMethod_setTourID
* Sets this.id to a provided tourName and id or `${tourName}--${uuid}` * @param {string} optionsId - True if we are going forward, false if backwar
shepherd.js/src/tour.ts:455
↓ 1 callersFunction_setupAdvanceOnHandler
* Sets up the handler to determine if we should advance the tour * @param step The step instance * @param selector * @private
shepherd.js/src/utils/bind.ts:10
↓ 1 callersMethod_skipStep
* Called when `showOn` evaluates to false, to skip the step or complete/cancel the tour if there are no more steps * @param {Step} step - The step
shepherd.js/src/tour.ts:422
↓ 1 callersMethod_storeOriginalTabIndex
* Stores the original tabIndex value of an element before modifying it. * Only stores the value if the element has a tabindex attribute. * @para
shepherd.js/src/step.ts:572
↓ 1 callersFunction_styleForStep
(step: Step)
shepherd.js/src/components/shepherd-modal.ts:203
↓ 1 callersMethod_styleTargetElementForStep
* Modulates the styles of the passed step's target element, based on the step's options and * the tour's `modal` option, to visually emphasize the
shepherd.js/src/step.ts:777
↓ 1 callersMethod_updateStateBeforeShow
* Before showing, hide the current step and if the tour is not * already active, call `this._setupActiveTour`. * @private
shepherd.js/src/tour.ts:440
↓ 1 callersFunctionaddArrow
(step: Step)
shepherd.js/src/utils/floating-ui.ts:233
↓ 1 callersFunctioncalculateCenteredScrollTop
(target)
shepherd.js/test/cypress/integration/test.acceptance.cy.js:588
↓ 1 callersFunctioncloseModalOpening
()
shepherd.js/src/components/shepherd-modal.ts:73
↓ 1 callersFunctioncountStars
( repo = 'shipshapecode/shepherd' )
landing/src/lib/github.ts:8
↓ 1 callersFunctioncreateShepherdCancelIcon
( cancelIcon: StepOptionsCancelIcon, step: Step )
shepherd.js/src/components/shepherd-cancel-icon.ts:5
↓ 1 callersFunctiondestroyTooltip
(step: Step)
shepherd.js/src/utils/floating-ui.ts:81
↓ 1 callersFunctionfloatingUIposition
(step: Step, shouldCenter: boolean)
shepherd.js/src/utils/floating-ui.ts:115
↓ 1 callersMethodgetTour
* Returns the tour for the step * @return The tour instance
shepherd.js/src/step.ts:461
↓ 1 callersFunctionhide
()
shepherd.js/src/components/shepherd-modal.ts:78
↓ 1 callersFunctionisElement
(value: T | Element)
shepherd.js/src/utils/type-check.ts:5
↓ 1 callersFunctionmakeOverlayPath
(overlayPaths: OverlayPathParams[])
shepherd.js/src/utils/overlay-path.ts:25
↓ 1 callersFunctionmergeTooltipConfig
( tourOptions: StepOptions, options: StepOptions )
shepherd.js/src/utils/floating-ui.ts:64
↓ 1 callersFunctionn
(e)
shepherd.js/dummy/js/prism.js:8
↓ 1 callersFunctionn
(e)
shepherd.js/dev/js/prism.js:8
↓ 1 callersFunctionn
(e)
shepherd.js/test/cypress/dummy/js/prism.js:524
↓ 1 callersMethodonce
* Adds an event listener that only fires once for the given event string. * * @param {string} event * @param {Function} handler * @param c
shepherd.js/src/evented.ts:42
↓ 1 callersFunctionplaceArrow
(el: HTMLElement, middlewareData: MiddlewareData)
shepherd.js/src/utils/floating-ui.ts:154
↓ 1 callersFunctionpositionModal
( modalOverlayOpeningPadding = 0, modalOverlayOpeningRadius: ModalRadiusType = 0, modalOverlayOpen
shepherd.js/src/components/shepherd-modal.ts:87
↓ 1 callersFunctionrafLoop
()
shepherd.js/src/components/shepherd-modal.ts:214
↓ 1 callersFunctionsetPosition
( target: HTMLElement, step: Step, floatingUIOptions: ComputePositionConfig, shouldCenter: boolean )
shepherd.js/src/utils/floating-ui.ts:89
next →1–100 of 151, ranked by callers