View
 

Submitting a plugin

Page history last edited by Scott González 1 yr ago

If you have developed a plugin that you feel would be beneficial to the jQuery UI project, you can submit it to the team for inclusion.  We welcome new plugin ideas from the community so please feel free to submit a plugin, especially if it matches our list of priorities and planned plugins. The team cannot guarantee resources for plugins that are not deemed high priority (see plugin prioritization) but if you have a terrific plugin and are motivated to get it through the process, even non-prioritized plugins can move through the development process fairly quickly.

 

 

How to submit a plugin for inclusion

Actually submitting a plugin to jQuery UI is a pretty simple process:

 

  • Get an account on the Google development group
  • Create a new message to the group outlining your suggested plugin. Please provide links to demos, documentation and a discussion of why you think this plugin should be included (see details above)
  • The jQuery UI team will probably ask a bunch of questions and will review your plugin to see if it fits into our priorities and strategic direction. Assessing an existing plugin requires a fair amount of time from the team so please be patient but if you're not getting input, feel free to ping the thread for help.

 

 

What should your plugin look like at submission?

Proposed plugins should adopt as much of the jQuery UI coding and design standards at submission time as possible to increase the probability it will be included. These standards include:

 

  • use the widget factory and be consistent with our coding standards
  • leverage exisiting core methods and utilities where appropriate (forcoming positionTo, overlay, shadow)
  • use the jQuery UI CSS framework and be ThemeRoller-ready
  • work in all our supported browsers (IE 6.0+, FF 2+, Safari 3.1+, Opera 9.0+, and Google Chrome)
  • use progressive enhancement and HTML 5 attributes and semantic markup
  • ideally already have ARIA attributes and other accessibility features (not required but recommended)
  • generally follow our goals and principles

 

A plugin must have at a minimum:

  1. a detailed description of the plugin's uses and functional specs of dependencies, options, methods, events and a case for why this is a popular and useful addition
  2. at least one demo page showing default functionality, ideally 1-2 additional demos showing popular options and variations to show the range of the plugin

 

 

What happens if your plugin is accepted?

If the team decides to accept your plugin, you will need to get SVN access to the jQuery UI repository set up. New plugin code is added to /branches/pluginName/ and do not have the same requirements and restrictions of those in /branches/dev/ which are the team's prioritized plugins under active development. These branches also aren't managed or kept up by the team so it is the plugin developer's responsibility to maintain an individual branch if it is not a team priority. You can learn more about the development process.   If the plugin is deemed high priority, it will be added to /branches/dev/pluginName and will have full support from the jQuery UI team.

 

 

What happens if your plugin is not accepted?

If the team decides not to accept your plugin, please do not get discouraged.  Just because the team cannot support your plugin now doesn't meant the team won't be able to support it in the future.  Again, we have limited resources and can therefore only accept so many plugins at any given time.  Don't let your code wither away just because the jQuery UI team isn't interested in it at a specific time.  If you've invested time in developing a plugin, there is likely an audience that is interested in using it.  Maintaining the code, proving its worth by increasing its popularity and adhering to the jQuery UI coding standards will also increase your chances of getting it included in the future.

Comments (1)

profile picture

Kartik Sehgal said

at 6:31 am on May 30, 2010

can you detail a bit more about submitting a plugin? If a plugin is submitted and ultimately approved, what is the role of the original author after that?

You don't have permission to comment on this page.