Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
reactour - npm Package Compare versions
Comparing version 1.8.7 to 1.9.0
@@ -13,3 +13,3 @@ "use strict"; | ||
| function _templateObject() { | ||
| var data = _taggedTemplateLiteral(["\n display: block;\n padding: 0;\n outline: 0;\n border: 0;\n background: none;\n font-size: 0;\n cursor: ", ";\n "]); | ||
| var data = _taggedTemplateLiteral(["\n display: block;\n padding: 0;\n outline: 0;\n border: 0;\n background: none;\n font-size: 0;\n cursor: ", ";\n"]); | ||
@@ -16,0 +16,0 @@ _templateObject = function _templateObject() { |
@@ -488,3 +488,3 @@ "use strict"; | ||
| onClick: onRequestClose | ||
| }))); | ||
| })), this.props.children); | ||
| } | ||
@@ -502,2 +502,3 @@ | ||
| highlightedMaskClassName: _propTypes.default.string, | ||
| children: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.element]), | ||
| className: _propTypes.default.string, | ||
@@ -504,0 +505,0 @@ closeWithMask: _propTypes.default.bool, |
| { | ||
| "name": "reactour", | ||
| "version": "1.8.7", | ||
| "version": "1.9.0", | ||
| "description": "Tourist Guide into your React Components", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -60,37 +60,38 @@ <p align="center"> | ||
| | Prop | Desc | Type | Default | Is Required | | ||
| | --------------------------- | --------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------- | ----------- | | ||
| | `accentColor` | Change `--reactour-accent` color (helper number + dots) | `string` | `#007aff` | | | ||
| | `badgeContent` | Function to customize Badge content `(current, total) => {}` | `func` | | | | ||
| | `className` | Custom class to add to the **helper** | `string` | | | | ||
| | `closeWithMask` | Close clicking the **mask** | `bool` | `true` | | | ||
| | `disableDotsNavigation` | Isn't possible to interact with helper dots | `bool` | | | | ||
| | `disableInteraction` | Isn't possible to interact with highlighted elements | `bool` | | | | ||
| | `disableKeyboardNavigation` | Isn't possible to interact with keyboard arrows | `bool` | | | | ||
| | `getCurrentStep` | Function triggered each time current step change | `func` | `step => { /* 'step' is the current step index */ }` | | | ||
| | `goToStep` | Programmatically change current step | `number` | | | | ||
| | `highlightedMaskClassName` | Custom class name for element which is overlaid target element | `string` | | | | ||
| | `inViewThreshold` | Scroll element to show when is outiside _viewport_ adding this threshold value | `number` | | | | ||
| | `isOpen` | You know… | `bool` | | ✅ | | ||
| | `lastStepNextButton` | Change _Next_ button in last step into a custom button to close the _Tour_ | `node` | | | | ||
| | `maskClassName` | Custom class to add to the **mask** | `string` | | | | ||
| | `maskSpace` | Padding between elemente showed and **mask** | `number` | `10` | | | ||
| | `nextButton` | Next navigation button text | `node` | | | | ||
| | `nextStep` | Override default `nextStep` function to use a custom one | `func` | | | | ||
| | `onAfterOpen` | Function triggered after open | `func` | `() => { document.body.style.overflowY = 'hidden' }` | | | ||
| | `onBeforeClose` | Function triggered before close | `func` | `() => { document.body.style.overflowY = 'auto' }` | | | ||
| | `onRequestClose` | Function triggered to close | `func` | | | | ||
| | `prevButton` | Prev navigation button text | `node` | | | | ||
| | `prevStep` | Override default `prevStep` function to use a custom one | `func` | | | | ||
| | `rounded` | Beautify helper + mask with border-radius (in px) | `number` | `0` | | | ||
| | `scrollDuration` | Smooth scroll duration when positioning the target element | `number` | `1` | | | ||
| | `scrollOffset` | Offset when positioning the target element | `number` | calculates the vertical center of the page | | | ||
| | `showButtons` | Show **helper** navigation butons | `bool` | `true` | | | ||
| | `showNavigation` | Show **helper** navigation dots | `bool` | `true` | | | ||
| | `showNavigationNumber` | Show number when hovers on each navigation dots | `bool` | `true` | | | ||
| | `showNumber` | Show **helper** number badge | `bool` | `true` | | | ||
| | `startAt` | Starting step each time the Tour is open | `number` | | | | ||
| | `steps` | Array of steps with info and `props` | [view bellow] | | ✅ | | ||
| | `update` | Value to listen if a forced update is needed | `string` | | | | ||
| | `updateDelay` | Delay time when forcing update. Useful when there are known animation/transitions | `number` | 1 | | | ||
| | Prop | Desc | Type | Default | Is Required | | ||
| | --------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------- | ----------- | | ||
| | `accentColor` | Change `--reactour-accent` color (helper number + dots) | `string` | `#007aff` | | | ||
| | `badgeContent` | Function to customize Badge content `(current, total) => {}` | `func` | | | | ||
| | `children` | Elements to appear after the _Mask_ (need to be styled correctly to have a `position` and `z-index` higher than _Mask_) | `node|elem` | `false` | | | ||
| | `className` | Custom class to add to the **helper** | `string` | | | | ||
| | `closeWithMask` | Close clicking the **mask** | `bool` | `true` | | | ||
| | `disableDotsNavigation` | Isn't possible to interact with helper dots | `bool` | | | | ||
| | `disableInteraction` | Isn't possible to interact with highlighted elements | `bool` | | | | ||
| | `disableKeyboardNavigation` | Isn't possible to interact with keyboard arrows | `bool` | | | | ||
| | `getCurrentStep` | Function triggered each time current step change | `func` | `step => { /* 'step' is the current step index */ }` | | | ||
| | `goToStep` | Programmatically change current step | `number` | | | | ||
| | `highlightedMaskClassName` | Custom class name for element which is overlaid target element | `string` | | | | ||
| | `inViewThreshold` | Scroll element to show when is outiside _viewport_ adding this threshold value | `number` | | | | ||
| | `isOpen` | You know… | `bool` | | ✅ | | ||
| | `lastStepNextButton` | Change _Next_ button in last step into a custom button to close the _Tour_ | `node` | | | | ||
| | `maskClassName` | Custom class to add to the **mask** | `string` | | | | ||
| | `maskSpace` | Padding between elemente showed and **mask** | `number` | `10` | | | ||
| | `nextButton` | Next navigation button text | `node` | | | | ||
| | `nextStep` | Override default `nextStep` function to use a custom one | `func` | | | | ||
| | `onAfterOpen` | Function triggered after open | `func` | `() => { document.body.style.overflowY = 'hidden' }` | | | ||
| | `onBeforeClose` | Function triggered before close | `func` | `() => { document.body.style.overflowY = 'auto' }` | | | ||
| | `onRequestClose` | Function triggered to close | `func` | | | | ||
| | `prevButton` | Prev navigation button text | `node` | | | | ||
| | `prevStep` | Override default `prevStep` function to use a custom one | `func` | | | | ||
| | `rounded` | Beautify helper + mask with border-radius (in px) | `number` | `0` | | | ||
| | `scrollDuration` | Smooth scroll duration when positioning the target element | `number` | `1` | | | ||
| | `scrollOffset` | Offset when positioning the target element | `number` | calculates the vertical center of the page | | | ||
| | `showButtons` | Show **helper** navigation butons | `bool` | `true` | | | ||
| | `showNavigation` | Show **helper** navigation dots | `bool` | `true` | | | ||
| | `showNavigationNumber` | Show number when hovers on each navigation dots | `bool` | `true` | | | ||
| | `showNumber` | Show **helper** number badge | `bool` | `true` | | | ||
| | `startAt` | Starting step each time the Tour is open | `number` | | | | ||
| | `steps` | Array of steps with info and `props` | [view bellow] | | ✅ | | ||
| | `update` | Value to listen if a forced update is needed | `string` | | | | ||
| | `updateDelay` | Delay time when forcing update. Useful when there are known animation/transitions | `number` | 1 | | | ||
@@ -97,0 +98,0 @@ ```js |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.61%
66320
- Lines of code
- increased by0.08%
1190
- Number of lines in readme file
- increased by0.74%
137
No dependency changes