Skip to content

Missing Select Plugin API documentation configuration options #763

Description

@delfuego

In digging through the Select Plugin API to implement it for the first time, I noticed that there are a few configuration options that are implemented in code but not documented on the main documentation page; this is the list I could figure out, with my best (educated) guesses for the functionality of some of them:

  • apiPageStart: this looks to control which page of results to request when making a remote call for options
  • apiTotalPath:
  • dropdownDirectionClasses
  • dropdownSpace
  • searchTemplate: allows setting the template for the input field that appears in searchable selects (e.g., to add aria attributes)
  • searchWrapperClasses: allows setting the classes for the div that encloses all the searchable functionality
  • searchWrapperTemplate: allows setting the template for the div that encloses all the searchable functionality
  • value: allows setting the initial value (at least for non-remote-loaded selects)
  • viewport

There are also a few undocumented properties for the apiFieldsMap object:

  • page, offset, limit
  • rest: an object that can contain any other content from each item in the remote-loaded results (and presumably then can be included via the option template)

I noticed a few other minor things, as well:

The configuration option optionGroupTemplate appears to have been replaced by optgroupTag — both are listed in the docs and shown to do the same thing, and optionGroupTemplate doesn't appear in the code for the plugin.

The configuration option additionalClasses is misspelled on the docs page as additinalClasses.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions