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

Minor confusion with docs when you need pages with single element #34

Open
dzebisati opened this issue Nov 12, 2024 · 1 comment
Open
Labels
documentation Improvements or additions to documentation

Comments

@dzebisati
Copy link

Hello!

First of all, thank you for creating and sharing this library! I’m really impressed with the depth and care you’ve brought to this project, especially in delivering a native solution that meets such a significant community need 👏🏻. The attention to detail is remarkable, and it’s clear how much effort and expertise went into making this possible.

When you need to use "single element page" functionality there can be some initial confusion. Developers may mistakenly think that the carousel is unsuitable for this specific use case, because there is no such options in API and page size are dynamically determined by the DOM layout.

It turns out, though, that this is easily resolved with the data-should-snap attribute, which perfectly handles such cases.

Clarifying this feature in the docs and maybe highlight in storybook could help users realize the full potential of this library.

Thank you again for all your hard work on this project!

@richardscarrott
Copy link
Owner

Hi @dzebisati,

Well done for a) finding the feature and b) figuring out a use for it as I appreciate it's not documented beyond this PR #27.

I presume your use case is to display multiple items at a time but have users scroll just one at a time? We could add a storybook example of this (PR welcome).

More broadly, I'd like to improve the docs at some stage so I'll consider this issue when I do.

@richardscarrott richardscarrott added the documentation Improvements or additions to documentation label Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants