Check out my latest project: Code Dumper

jQuery API Browser

Ever since jQuery 1.1.3 the old API browser hasn't been updated due to incompatibilities in the documentation (though that's mostly assumptions). Although the new docs is comprehensive, I've always liked the quick access the old API browser gave.

As such, I've got about my own way re-building an API browser based on the new documentation.

Check out the new jQuery API browser

It's entirely driven by JavaScript (with a tiny smidge of .htaccess). The most important two features for me were to be able to quickly jump to any method either by searching or just to check the params.

This can either be done by the live search or via the URL, e.g: http://remysharp.com/jquery-api/bind

If John, or anyone else on the jQuery team are interested, I'd much rather see this sitting on the http://jquery.com/api URL, just get in touch - it's just easier to type :-)

15 Responses to “jQuery API Browser”

  1. Perfectly awesome... but...

    It doesn't like capital letters. Try slideToggle - it breaks after the capital T. A lower case t works fine.

    This is definitely getting bookmarked.

  2. @Kyle - cheers for that, it's fixed now.

  3. Remy, can you make this downloadable so it can be run locally?

  4. wow! thanks! excellent stuff

  5. Nice, this is really helpful. You should add autocomplete="off" to the input tag though, it's really annoying getting browser suggestions as I type.

  6. Nice work. Thx. But it seems to be not completed, though. You won't find the $() function, so there might be other functions which arent't there at all. Will the API browser be completed in the next future?

  7. @Jens - actually the API documentation doesn't mention the $() function anymore. It's found under jQuery().

    I have done some conversion to make it easier to find functions like jQuery.ajax() and made them searchable under 'ajax'.

    However, I think there is some argument for aliasing the '$' search term against the jQuery() functions.

    Just so that you're reassured - there's no missing functions in the API as it derives directly from the wiki API docs.

  8. Thanks for making this clear. So it will be safe and a fun to use your new API.

  9. Remy, I got confused with the length details the because it has () after the length title.

    http://remysharp.com/jquery-api/length

    http://groups.google.com.au/group/jquery-en/browse_frm/thread/31f2029bacf6272a?hl=en

  10. @Yansky - thanks for pointing that out. I post this on the groups thread, but I'll add it here too:

    I've got a small update to go for the API browser that will include selectors as well as properties and functions, and I'll make sure that only functions include the parentheses.

  11. Hi. This is an excellent work. Anyone planning to make a (firefox/seamonkey) sidebar-friendly version?. That would be the icing on the cake. :)

  12. I've updated the API browser to include the following:

    * Indicator to show function, selector or property
    * Only show parenthesis if it's a function
    * Included the 'options' tab for more detail about the function

    @Mark - there's changes coming to the API browser which, in particular, splits the view from the backend - i.e. making it easy for someone to reuse the functionality for a sidebar plugin if they want.

  13. Hi,

    any chance of a version for local usage?

    Thanks,

  14. @Pedro - it's in progress, just really, really behind! I'll post it up here, so keep an eye on the RSS feed.

  15. Ok, if you need any help with that, feel free.

    Best regards,

Leave a Reply
Not required

CODE: Please escape code and wrap in <pre><code>, doing so will automatically syntax highlight