Add 'auto' as placement option

[patrikholcak]

About

As discussed in #2583, adding autoPlacement is not possible due to flip being automatically added by shepherd. This PR re-introduces auto placements, which were removed a couple of versions back with migration from popper to floating-ui.

When step attachTo.on is set to auto[-start|end], we automatically add autoPlacement to the middlewares and remove flip, which isn’t compatible with it.

Proposed changes

• add auto[-start|end] placement options, which were removed when popper was replaced with floating-ui https://github.com/shipshapecode/shepherd/blob/76fe594ccdf125c42ceddbaa44e017497d8c441a/src/types/step.d.ts#L232

Let me know if there’s any changes you want me to make 🙏

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
shepherd-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2024 0:50am
shepherd-landing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2024 0:50am

[vercel[bot]]

@patrikholcak is attempting to deploy a commit to the shipshapecode Team on Vercel.

A member of the Team first needs to authorize it.

[RobbieTheWagner]

Thanks for the PR @patrikholcak! Do we need to add these new options to the docs?

[patrikholcak]

I’m not sure! Looks like it’s correctly added to the type in docs. Let me know if you want me to add a recipe, though not sure if that’s needed

[RobbieTheWagner]

@patrikholcak I think we also mention it in https://docs.shepherdjs.dev/guides/usage/ and perhaps other places. Just want to make sure we update it all!

[patrikholcak]

@RobbieTheWagner, checked the code and looks like the usage page is the only other place which has a list of positions, so that should (probably?) be it!

One thing I’m debating here is whether to also disable the shift middleware. From my testing it still can produce weird positions due to the limiter: limitShift(), option. Maybe the best solution is to have an option to disable the default middlewares altogether (#3010).

[RobbieTheWagner]

@RobbieTheWagner, checked the code and looks like the usage page is the only other place which has a list of positions, so that should (probably?) be it!

One thing I’m debating here is whether to also disable the shift middleware. From my testing it still can produce weird positions due to the limiter: limitShift(), option. Maybe the best solution is to have an option to disable the default middlewares altogether (#3010).

@patrikholcak awesome, thank you!

I think ideally we make things "just work" for folks. We have updated the order of merging for middleware, so if you want to override any middleware, whatever you pass in floatingUIOptions will win.

That being said, I don't think people should need to override the middleware to get this new auto option to work. Can you explain what you mean by weird positions? I want to make this as seamless for users as possible.

[patrikholcak]

I agree with the idea of making things "just work." However, sometimes — when using libraries — you hit a brick wall simply because you can’t override certain defaults that were put in place to make things simpler (or ensure a degree of backwards compatibility in this case). In those cases, I think those should definitely be overridable. That said, I don’t think everything needs to be customisable — but I digress. That’s a discussion that PR.

---

What I meant by weird positioning is: sometimes when the target element is in a corner, the tour step can get clip outside of the window. But I am not able to replicate it now 🤷

And yes, looks like I am able to override the default shift middleware, so I can add padding from the sides (maybe that fixed it)

Anyway, this should be it. :shipit: 🙏

[ulken]

@RobbieTheWagner when can I expect this to be released?

[RobbieTheWagner]

@ulken sorry I did not realize we had not released it. I just pressed the button, so hopefully it'll be out here in a sec.