search

ninja / ui

Ninja User Interface, the jQuery plugin for lethal interaction.
http://ninjaui.com
Apache License 2.0
284 stars 23 forks source link

Need more documentation #52

Open mboudreau opened 12 years ago

mboudreau commented 12 years ago

I would like to have some kind of API for all the controls, I found a few things here and there, but nothing official.

uipoet commented 12 years ago

Every Ninja UI object and its options/callbacks/methods are documented on the website: http://ninjaui.com/#samples. Is there a specific part of the API that you feel is undocumented?

mboudreau commented 12 years ago

I feel like there's not enough information on them. What do the functions do, how do you use them, etc...

For instance, the autosuggest is cool, but the example was poorly made. I didn't know that I had to create a div first, and then add the "autocomplete" to it. I started off with an input and it added another input within it. Needless to say, that didn't work very well.

uipoet commented 12 years ago

Thank you for the feedback. We are working on an updated version of our site and will flesh out the documentation further. I will leave this issue open until that happens.

On the specific issue you mentioned. All Ninja UI objects completely draw their HTML. This is different than other JavaScript UI libraries that have you create the HTML in advance and then overwrite. This is done for two reasons:

  1. It keeps the API of Ninja UI completely JavaScript. All you need to do in HTML is mark where you want an object to go.
  2. The objects and their binding can be created before the page finishes loading so they may be inserted anywhere in the page, ready to go.
mboudreau commented 12 years ago

I understand that now, and I appreciate the thought behind it, I think it's a better way to do things. However, I was still somewhat confused when starting it before grasping the concept. I'd be willing to help on some docs if something were to be available on github.

Cheers.

uipoet commented 12 years ago

Awesome. Our current site is in fact available on GitHub: https://github.com/ninja/ninja.github.com

Our new and improved update, which is not currently on GitHub, will be and we'd love a hand with making the first time experience a good one for others.