jquery-ui README

The project's README from github.com/jquery/jquery-ui. As one markdown file: README.md.

jQuery UI - Interactions and Widgets for the web

Note: jQuery UI is in maintenance-only mode. Please read the project status blog post for more information.

jQuery UI is a curated set of user interface interactions, effects, widgets, and themes built on top of jQuery. Whether you're building highly interactive web applications, or you just need to add a date picker to a form control, jQuery UI is the perfect choice.

If you want to use jQuery UI, go to jqueryui.com to get started, jqueryui.com/demos/ for demos, api.jqueryui.com for API documentation, or the Using jQuery UI Forum for discussions and questions.

If you want to report a bug/issue, please visit the GitHub issues page. Archive of older bug reports is kept for historical reasons in read-only mode at bugs.jqueryui.com. If any of them still matters to you, please open a bug about it on GitHub, linking to the legacy bugs.jqueryui.com issue for context.

If you are interested in helping develop jQuery UI, you are in the right place. To discuss development with team members and the community, visit the Developing jQuery UI Forum or #jqueryui-dev on irc.freenode.net.

For Contributors

If you want to help and provide a patch for a bugfix or new feature, please take a few minutes and look at our Getting Involved guide. In particular check out the Coding standards and Commit Message Style Guide.

In general, fork the project, create a branch for a specific change and send a pull request for that branch. Don't mix unrelated changes. You can use the commit message as the description for the pull request.

For more information, see the contributing page.

Running the Unit Tests

Run the unit tests manually with appropriate browsers and any local web server. See our environment setup and information on running tests.

You can also run the unit tests npm run test:unit -- --help.

jquery-ui (jquery/jquery-ui)

Searching Database…

11.3K ·GitHub
What is this?jQuery UI is the official user interface library for jQuery: a curated set of interactions, effects, widgets, and themes layered on top of jQuery.
Is it a library I add to my web pages, or a standalone app?It's a JavaScript library you include in web pages — not a standalone app or service. It extends jQuery with ready-made interface components rather than replacing jQuery.
How do I add it to a project?The README points to jqueryui.com to get started, with demos at jqueryui.com/demos and the API reference at api.jqueryui.com. The repo itself is a standard npm/Grunt project.
Do I need anything else on the page first?Just jQuery — it is the library's only runtime dependency, since all of jQuery UI is built on top of it. No backend or other libraries are required.
Is the project still actively developed?No — it is in maintenance-only mode, so expect upkeep and fixes rather than new features. The README links a project status blog post with the details.
How mature is this project?It's the official jQuery UI library, public on GitHub since 2010 with around 11.3k stars. Today it is maintained rather than expanded, which fits a stable, battle-tested UI library.
Is it free to use?Yes — it's a free, open-source library, also packaged for npm. The README doesn't quote license terms, so check the LICENSE file in the repo for the specifics.
Creator
jquery
Size
30.3 MB
Stars
11.3K
Age
16y
Commits · 90 Days