Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 4x 4x 1x 1x | /*
MIT License
Copyright (c) 2015, Gil Barbara
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
import Joyride, {ACTIONS, EVENTS, LIFECYCLE, STATUS} from 'react-joyride'
import PropTypes from 'prop-types'
import {atomButtonColors, atomButtonDesigns, atomButtonShapes, atomButtonSizes} from '@s-ui/react-atom-button'
import Injector from '@s-ui/react-primitive-injector'
import DefaultTooltip from './Tooltip/index.js'
import {
DEFAULT_SCROLL_DURATION,
DEFAULT_SCROLL_OFFSET,
DEFAULT_SPOTLIGHT_PADDING,
DEFAULT_TOOLTIP_ACTION_BUTTONS_IDS,
DEFAULT_Z_INDEX,
STEP_BEACON_PLACEMENT_TYPES,
STEP_PLACEMENT_TYPES
} from './settings.js'
const MoleculeCoachmark = ({
beaconComponent,
callback,
continuous = true,
debug = false,
tooltipOptions,
disableCloseOnEsc = false,
disableOverlay = false,
disableOverlayClose = true,
disableScrolling = false,
disableScrollParentFix = false,
floaterProps,
getHelpers = null,
hideBackButton = false,
hideCloseButton = false,
locale,
run = true,
scrollDuration = DEFAULT_SCROLL_DURATION,
scrollOffset = DEFAULT_SCROLL_OFFSET,
scrollToFirstStep = false,
shopSkipButton = false,
showProgress = false,
spotlightClicks = false,
spotlightPadding = DEFAULT_SPOTLIGHT_PADDING,
stepIndex,
steps,
styles,
tooltipComponent: CustomTooltipComponent
}) => {
return (
<Joyride
beaconComponent={beaconComponent}
callback={callback}
continuous={continuous}
debug={debug}
disableCloseOnEsc={disableCloseOnEsc}
disableOverlay={disableOverlay}
disableOverlayClose={disableOverlayClose}
disableScrolling={disableScrolling}
disableScrollParentFix={disableScrollParentFix}
floaterProps={floaterProps}
{...(getHelpers && {getHelpers})}
hideBackButton={hideBackButton}
hideCloseButton={hideCloseButton}
locale={locale}
run={run}
scrollDuration={scrollDuration}
scrollOffset={scrollOffset}
scrollToFirstStep={scrollToFirstStep}
shopSkipButton={shopSkipButton}
showProgress={showProgress}
spotlightClicks={spotlightClicks}
spotlightPadding={spotlightPadding}
stepIndex={stepIndex}
steps={steps}
styles={{
options: {
zIndex: DEFAULT_Z_INDEX,
...styles?.options
},
...styles?.components
}}
// eslint-disable-next-line react/no-unstable-nested-components
tooltipComponent={props => (
<Injector
{...props}
tooltipOptions={tooltipOptions}
showProgress={showProgress}
hideBackButton={hideBackButton}
>
{CustomTooltipComponent ? <CustomTooltipComponent /> : <DefaultTooltip />}
</Injector>
)}
/>
)
}
MoleculeCoachmark.displayName = 'MoleculeCoachmark'
MoleculeCoachmark.propTypes = {
/** A React component or function to be used instead the default Beacon. Can be a custom component */
beaconComponent: PropTypes.node,
/** It will be called when Joyride's state changes. it returns a single parameter with the state */
callback: PropTypes.fn,
/** The tour is played sequentially with the Next button. */
continuous: PropTypes.bool,
/** Log Joyride's actions to the console. */
debug: PropTypes.bool,
/* Additional tooltip options to be passed down as props specifying whether the tooltip is custom or default */
tooltipOptions: PropTypes.shape({
badge: PropTypes.node,
actionButtons: PropTypes.arrayOf([
PropTypes.shape({
id: PropTypes.oneOf([DEFAULT_TOOLTIP_ACTION_BUTTONS_IDS.BACK, DEFAULT_TOOLTIP_ACTION_BUTTONS_IDS.NEXT]),
color: PropTypes.oneOf([Object.values(atomButtonColors)]),
design: PropTypes.oneOf([Object.values(atomButtonDesigns)]),
size: PropTypes.oneOf([Object.values(atomButtonSizes)]),
shape: PropTypes.oneOf([Object.values(atomButtonShapes)]),
isNegative: PropTypes.bool
})
]),
closeIcon: PropTypes.node,
headImage: PropTypes.shape({url: PropTypes.string, alt: PropTypes.string}),
image: PropTypes.shape({url: PropTypes.string, alt: PropTypes.string}),
// Flexible props to configurate your custom tooltip
optionalProps: PropTypes.object
}),
/** Disable closing the tooltip on ESC. */
disableCloseOnEsc: PropTypes.bool,
/** Don't show the overlay. */
disableOverlay: PropTypes.bool,
/** Don't close the tooltip when clicking the overlay. */
disableOverlayClose: PropTypes.bool,
/** Disable auto scrolling between steps. */
disableScrolling: PropTypes.bool,
/** Disable the fix to handle "unused" overflow parents */
disableScrollParentFix: PropTypes.bool,
/** Options to be passed to react-floater. */
floaterProps: PropTypes.object,
/** Get the store methods to control the tour programmatically. prev, next, go, close, skip, reset, info */
getHelpers: PropTypes.func,
/** Hide the "back" button. */
hideBackButton: PropTypes.bool,
/** Hide the "close" button. */
hideCloseButton: PropTypes.bool,
/** The strings used in the tooltip. */
locale: PropTypes.shape({
back: PropTypes.string,
close: PropTypes.string,
last: PropTypes.string,
next: PropTypes.string,
open: PropTypes.string,
skip: PropTypes.string
}),
/** Run/stop the tour. */
run: PropTypes.bool,
/** The scroll distance from the element scrollTop value. */
scrollOffset: PropTypes.number,
/** The duration for scroll to element. */
scrollDuration: PropTypes.number,
/** Scroll the page for the first step. */
scrollToFirstStep: PropTypes.bool,
/** Display the tour progress in the next button */
showProgress: PropTypes.bool,
/** Display a button to skip the tour. */
shopSkipButton: PropTypes.bool,
/** Allow mouse and touch events thru the spotlight. */
spotlightClicks: PropTypes.bool,
/** The padding of the spotlight. */
spotlightPadding: PropTypes.number,
/** When using stepIndex, the controlled mode is activated, should be controlled with the callback prop */
stepIndex: PropTypes.number,
/** The tour's steps. */
steps: PropTypes.arrayOf(
PropTypes.shape({
target: PropTypes.oneOfType([PropTypes.string, PropTypes.node]).isRequired,
heading: PropTypes.node,
content: PropTypes.node.isRequired,
disableBeacon: PropTypes.bool,
event: PropTypes.func,
isFixed: PropTypes.bool,
offset: PropTypes.number,
placement: PropTypes.oneOf(Object.values(STEP_PLACEMENT_TYPES)),
placementBeacon: PropTypes.oneOf(Object.values(STEP_BEACON_PLACEMENT_TYPES)),
styles: PropTypes.object,
title: PropTypes.node
})
).isRequired,
/** Override the styling of the Tooltip globally */
styles: PropTypes.object,
/** A React component or function to be used instead the default Tooltip excluding the arrow. */
tooltipComponent: PropTypes.node
}
export {ACTIONS as moleculeCoachmarkActions}
export {EVENTS as moleculeCoachmarkEvents}
export {STATUS as moleculeCoachmarkStatus}
export {LIFECYCLE as moleculeCoachmarkLifeCycle}
export {DEFAULT_TOOLTIP_ACTION_BUTTONS_IDS as moleculeCoachmarkActionButtonIds}
export default MoleculeCoachmark
|