Skip to content
This repository

A jQuery plugin for creating beautiful, graceful, and painless custom dropdowns.

branch: master
readme.md

DropKick

Creating custom dropdowns is usually a tedious process that requires a ton of extra setup time. Oftentimes lacking conveniences that native dropdowns have such as keyboard navigation. DropKick removes the tedium and lets you focus on making s@#t look good.

Requirements:

DropKick requires the latest version of jQuery, available at jQuery.com. Currently we're using jQuery 1.10.2.

How it works:

DropKick works by transforming your existing, boring <select> lists into beautiful, customizable HTML dropdowns. The name attribute is the only one that is required. You should also set a tabindex attribute to enable navigation via tabbing. When an option is selected in a DropKick menu, the corresponding <select> value is updated. This means that your forms and AJAX requests should work the same without having to make any changes.

Features:

  • Acts Just Like A Select
  • Keyboard Navigation: Keyboard navigation in DropKick is very similar to native <select> navigation. While highlighted, pressing enter, up, or down on your keyboard will open the dropdown. While opened, pressing up or down will navigate through the options, and pressing enter will select the currently highlighted option.

  • Dynamic Selects: Use $(object).dropkick('refresh') method to update dropkick if the <select> content has changed dinamically

  • Theming: DropKick was made to be easily theme-able and supports dynamic theme changing.

  • Custom Callbacks

How to use:

  • Make sure you have jQuery 1.10 or later running
  • Add all the DK files to their proper spots (CSS files can be added to your main CSS file if you like)
  • Set a class or id on the select(s)
  • Call $('#select').dropkick();
  • Have a happy time with new awesome selects!

Please see examples.html or the DropKick homepage for more ways to use DK.

Compatibility:

DropKick was tested on Opera 10+, Google Chrome 10+, FireFox 5+, Safari 5+, and Internet Explorer 7+. IE6 is not supported and will simply continue using your plain dropdowns instead.

Whats new in 1.4?

Changes thanks to acemir!

  • 'refresh' method now updates only '.dk_options_inner', instead of destroy and rebuild the whole dropkick instance
  • Clicking a label now focus the respective select dropkick
  • Abillity to set a placeholder that is hidden from the options by setting 'disabled selected' to the first select option
  • Corrects border-radius when the dropkick opens on top by adding '.dk_open_top' class to container
  • This version of DropKick was tested and confirmed that works with jQuery 1.7+

What changed in previous versions?

Contributing

Making a Pull Request

Please make all future pull requests against the develop branch. Thanks! :D

Found a bug?

Please let us know.

What next:

Version 2.0

Version 2.0 is going to be a compleate rewrite of the plugin. Suggestions are welcome for features :)

Got an idea for improving DropKick? Or maybe a bug fix? Please feel free to fork a copy and submit a pull request! We've merged in over 30 pull requests in the past month. We're no stranger to it.

Maintained by:

Robert DeLuca

Wil Wilsman

Created by:

Jamie Lottering

Something went wrong with that request. Please try again.