Public Api Events need improved documentation

13 views
Skip to first unread message

mportugal

unread,
Aug 14, 2016, 7:46:51 PM8/14/16
to UI-Grid Support

Hi!

Your tutorials documentation is great. My team has been able to quickly get started using your components. However, the API documentation could use some work. It is not trivial to find events and examples of how they can be implemented.

For example, it took us a long time to figure out how to use the filtersChanged Event. The events are not searchable in the search box for the API. One of my team members happened to stumble on this:http://ui-grid.info/docs/#/api/ui.grid.core.api:PublicApi which lists the event near the bottom of the page, while he was looking for something else. Although he found it, there was not an example of how to use this within the code. We had to go somewhere else to find an example (one of your issue requests had a code snippet).

It would be great if there exists a list of all Events which are supported for use by ui.grid, and that these events are searchable in the API/Tutorial search box: http://ui-grid.info/docs/#/api

Thanks!


- Credit to rwtaggart

Reply all
Reply to author
Forward
0 new messages