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

Add link to Selectize options list in API documentation of Selectize() #2079

Open
4 of 5 tasks
rrlapointe opened this issue Jan 21, 2024 · 0 comments
Open
4 of 5 tasks

Comments

@rrlapointe
Copy link

I did:

  • Search for if my issue has already been submitted
  • Make sure I'm reporting something precise that needs to be fixed
  • Give my issue a descriptive and concise title
  • Create a minimal working example on JsFiddle or Codepen
    (or gave a link to a demo on the Selectize docs)
  • Indicate precise steps to reproduce in numbers and the result,
    like below

When reading the documentation at https://selectize.dev/docs/API/selectize for the Selectize($input, settings) function, there is no reference to where I can find a complete list of keys accepted in the settings object. It just describes the settings as "Options to apply for selectized element" and does not say what options exist. Please include a link to the options list in the API documentation.

Steps to reproduce:

  1. Navigate to https://selectize.dev/docs/API/selectize
  2. Read the documentation of Selectize($input, settings)
  3. Be confused about what the accepted options are

Expected result: As a user, I do not expect there to be critical information in the "Get Started" section that is not in the "API Documentation". As a user, I expect the "API Documentation" to be complete and include everything I need to know if I am not looking for tutorials/working examples.

Actual result: I was confused for days until I saw that this list is included in the "Get Started" section (https://selectize.dev/docs/usage), where I did not initially look for it because I did not expect to find critical API documentation there.

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

No branches or pull requests

1 participant