Skip to content

Unclear documentation of slider component: dots, included, marks vs. ticks missing fail-safe for incorrect usage results in problematic script execution #1765

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

Closed
1 task done
keikoro opened this issue Feb 9, 2020 · 6 comments

Comments

@keikoro
Copy link

keikoro commented Feb 9, 2020

  • I have searched the issues of this repository and believe that this is not a duplicate.

Version

1.4.10

Environment

Linux, FF 68.4.1esr, Vue 2.6.10

Reproduction link

Edit on CodeSandbox

Steps to reproduce

scenario A)
include :dots='true' in existing slider where :step='n' (where n is a number value > 0)

scenario B)
include :dots='true' in existing slider where :step='null'

What is expected?

scenario A)
according to the documentation, dots decide "Whether the thumb can drag over tick only." – to me this translates to: dots won't let the user drop the active slider demarcation randomly, but only on pre-defined markers of segments (confusingly sometimes referred to as ticks, sometimes as marks)

scenario B)
the same as above, because the documentation does not warn against using dots with :step='null'

What is actually happening?

scenario A)
circle marks appear on the slider at every mark (or step), but the behaviour of the slider does not change as advertised. In fact, when steps are defined (given a positive value), the user can only ever drag and drop the slider onto a "step mark" anyway (even if it's invisible), regardless of if there are dots or not.

scenario B)
the script slows down the browser to a point it prompts the user to halt the script or continue waiting; on checking the dev console, it appears a warning regarding dots and :step='null' is logged to the console, but no fail-safe is built into the script


Please add a third category for issues having to do with documentation to your ticket types dropdown.

It's awkward to be greeted by a message saying normal GitHub issues will be ignored and to then have to fill out a bug report and provide a minimal reproduction for issues which aren't bugs but can be attributed to incomplete documentation or imprecise wording / translation (scenario A).

@keikoro
Copy link
Author

keikoro commented Feb 9, 2020

Two more notes:

  • the codesandbox template you provide does not include the ant-design-vue dependency and thus produces an error
  • the preview of your issue form ignores double spaces in Markdown for linebreaks (which work fine on GitHub directly)

@keikoro
Copy link
Author

keikoro commented Feb 9, 2020

Relatedly, the following warning:

Warning: Slider[max] - Slider[min] (%s) should be a multiple of Slider[step] (%s)

which gets output to the dev console as a result of me using :step="2" with :min="5", is something which should also be part of the documentation. Issuing warnings about potential problems to the console after the fact is not sufficient.

@github-actions
Copy link

github-actions bot commented Jan 4, 2021

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days

@github-actions github-actions bot added the Stale label Jan 4, 2021
@keikoro
Copy link
Author

keikoro commented Jan 5, 2021

Well, if these problems haven't been fixed yet, they still need fixing.

@github-actions github-actions bot removed the Stale label Jan 6, 2021
@github-actions
Copy link

github-actions bot commented Mar 8, 2021

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days

@github-actions
Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant