search

webismymind / editablegrid

EditableGrid is an open source Javascript library aimed at turning HTML tables into advanced editable components. It focuses on simplicity: only a few lines of code are required to get your first table up and running.
http://www.editablegrid.net
Other
795 stars 272 forks source link

Documentation needed... #1

Closed ThomasBurleson closed 11 years ago

ThomasBurleson commented 14 years ago

Please provide - in the source code - better documentation. For example, the class EditableGrid.php...

  1. why is this needed?
  2. what is the primary API?
  3. where in the "process" is this server functionality used?
webismymind commented 14 years ago

We'll provide a better documentation in the next version, soon.

In the meantime, know that the PHP class is there to facilitate the generation of the XML data on the server side. Its use is not mandatory, it's only supposed to be easier than to directly write the XML. On our example, we use a local XML file, but this can be replaced by server-side generated XML. We'll provide an example of this in the next version to come.

drzraf commented 12 years ago

php/EditableGrid.php::addColumn() parameters may really be worse some API documentation. It's not that obvious and would help a lot. $field and $bar use is especially difficult to understand.

webismymind commented 12 years ago

Definitely, there is a lack of documentation in EditableGrid. Il'try to take care of this, starting by EditableGrid.php which is almost completely undocumented. Some recent features (such as server side pagination/sorting/filtering) are also completely undocumented.

snukala commented 12 years ago

Can you please provide an example on how to use the class in EditableGrid.php ? I am looking to send database array to the class and get the json that the data grid would need.

drzraf commented 12 years ago

see "editablegrid-mysql-example.tgz" in the "downloads" section

zazzou commented 11 years ago

hi, I'm a beginner and I use this wonderfull editablegrid because I used datatable and I think yours is better. So I have a problem with filtering and pagination with the server side example, it's work with the mysql database but there aren't these functionnalities (filtering, sorting and pagination), I don't know how to do this... Thanks to you for the help