You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I started using this library and I quite like it. However, I struggle with some features or rather their documentation. The current behavior of the placement: "center" option is not really intuitive for new users.
To Reproduce
Create a Tour with the steps below:
{
target: 'body',
title: 'Current behavior: This step has a spotlight on the full body and a beacon',
content: 'Expected behavior: This step has no spotlight and possibly a beacon'
},
{
target: 'body',
title: 'Current behavior: This step has a spotlight on the full body and no beacon',
content: 'Expected behavior: This step has no spotlight and no beacon',
disableBeacon: true
},
{
target: '.some-large-div',
title: 'Current behavior: This step has no spotlight, no beacon and is centered within the body',
content: 'Expected behavior: This step has a spotlight on .some-large-div, is centered within .some-large-div and has a beacon',
placement: 'center'
}
Expected behavior
I would expect the expected behaviors described in the content of the steps. The placement center currently does some magic (disables beacon, centers within body, not actual target and disables spotlight), but it does not really have much to do with the placement. I would still want to have to possibility, to disable the spotlight on (possibly any body targets - which currently is not the case) and would love to have to possibility to center within a target.
To me it would make more sense to introduce a new disableSpotlight property to the steps or something similar with the behavior currently implemented for the center placement. Or the documentation should at least be updated and point out this special behavior. (currently it only says that I should set the target to body with this placement option, not including the beacon behavior or removal of the spotlight)
Run npx envinfo --system --binaries --npmPackages react-joyride
This discussion was converted from issue #1152 on March 24, 2025 19:56.
Heading
Bold
Italic
Quote
Code
Link
Numbered list
Unordered list
Task list
Attach files
Mention
Reference
Menu
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
🐛 Bug Report
I started using this library and I quite like it. However, I struggle with some features or rather their documentation. The current behavior of the placement: "center" option is not really intuitive for new users.
To Reproduce
Create a Tour with the steps below:
Expected behavior
I would expect the expected behaviors described in the content of the steps. The placement center currently does some magic (disables beacon, centers within body, not actual target and disables spotlight), but it does not really have much to do with the placement. I would still want to have to possibility, to disable the spotlight on (possibly any body targets - which currently is not the case) and would love to have to possibility to center within a target.
To me it would make more sense to introduce a new disableSpotlight property to the steps or something similar with the behavior currently implemented for the center placement. Or the documentation should at least be updated and point out this special behavior. (currently it only says that I should
set the target to body
with this placement option, not including the beacon behavior or removal of the spotlight)Run
npx envinfo --system --binaries --npmPackages react-joyride
Paste the results here:
Beta Was this translation helpful? Give feedback.
All reactions