Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: add some documentation on IonicSlides #2458

Closed
wants to merge 1 commit into from

Conversation

arnotixe
Copy link
Contributor

WIP: would be great to have some documentation on IonicSlides actually do. Migrating from ion-slides I got the regression that pinch zoom on mobiles work, but doubleclick to zoom (desktop) stopped working. Puzzled because https://swiperjs.com/types/interfaces/types_modules_zoom.zoomoptions says toggle is default true - and then I came to think about IonicSlides.

Not sure this is the best place to put it though, but it would be convenient with a list of what settings IonicSlides overrides somewhere, and link to it.

WIP: would be great to have  some documentation on IonicSlides actually do. Migrating from ion-slides I got the regression that pinch zoom on mobiles work, but doubleclick to zoom (desktop) stopped working. Puzzled because https://swiperjs.com/types/interfaces/types_modules_zoom.zoomoptions says toggle is default true - and then I came to think about IonicSlides.

Not sure this is the best place to put it though, but it would be convenient with a list of what settings IonicSlides overrides somewhere, and link to it.
@vercel
Copy link

vercel bot commented Jul 20, 2022

@arnotixe is attempting to deploy a commit to the Ionic Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@thetaPC thetaPC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The requested changes will also need to be applied to:

  1. the rest of the frameworks (React and Vue)
  2. version 6 (version_docs/version-6/FRAMEWORK/slides.md)

@@ -166,7 +166,7 @@ See <a href="https://swiperjs.com/angular#usage" target="_blank" rel="noopener n

## The IonicSlides Module

With `ion-slides`, Ionic automatically customized dozens of Swiper properties. This resulted in an experience that felt smooth when swiping on mobile devices. We recommend using the `IonicSlides` module to ensure that these properties are also set when using Swiper directly.
With `ion-slides`, Ionic automatically customized dozens of Swiper properties, for example turning off zoom on doubleclick. This resulted in an experience that felt smooth when swiping on mobile devices. We recommend using the `IonicSlides` module to ensure that these properties are also set when using Swiper directly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of using an example, let's mention in the docs to review the provided properties from IonicSlides.tsx. This would allow users to quickly reference what properties are being set through IonicSlides Module.

I would recommend adding it to the end of the paragraph.

@thetaPC
Copy link
Contributor

thetaPC commented Apr 25, 2023

Closing in favor of this up-to-date PR: #2934

@thetaPC thetaPC closed this Apr 25, 2023
@thetaPC
Copy link
Contributor

thetaPC commented Apr 25, 2023

Thanks for the issue! This has been resolved via #2934 and will be available soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants