DataTable, form widget not documented about docs

[daftspunk]

The widget itself should be called datatable. We will document it soon, most likely as part of the planned API docs.

[LukeTowers]

That readme only mentions one event, however I've found seven events:

data.getRecords
data.getCount
data.createRecord
data.updateRecord
data.deleteRecord
table.getDropdownOptions
table.getAutocompleteOptions

I've just listed in them my master list of OctoberCMS events so far, but more info on what this is for and how to utilize it would be great :)

[LukeTowers]

API docs are sparse on this right now, but available here: http://octobercms.com/docs/api/backend/formwidgets/datatable

@daftspunk Should the API docs generator be looking for additional documentation in the form of an identically named .md file to include with the inline documentation as well, or at least list them in the API docs folders that get generated? http://octobercms.com/docs/api/backend/widgets/table doesn't include all of the information that https://github.com/octobercms/october/blob/master/modules/backend/widgets/table/README.md does.

[daftspunk]

No, one is PHP docs other is JS docs.

[datune]

@daftspunk Any update for this?

[LukeTowers]

@datune @daftspunk doesn't really check his GitHub notifications, reach out to him directly on Slack or email if you want a better chance of a response.

[mohsin]

@LukeTowers Is there any documentation available on using a Server-side data table? I'm trying to use it in a form and I'm not able to figure it out.

[LukeTowers]

@SaifurRahmanMohsin see https://github.com/octobercms/docs/blob/master/backend-forms.md#data-table. The website will be updated with the github doc updates soon. @bennothommo does that documentation cover off any custom PHP stuff required for the use of that widget?

[bennothommo]

@LukeTowers no, just the configuration side at the moment. From what I can tell, I think the server-side data table functionality may not be complete.

[mohsin]

@bennothommo The server side data table doesn’t seem to work at all when used in a backend form. I think that it is being forced to be set as “client” and so there isn’t really a way to make it work as server-side... unless I’m missing something, which is why I am requesting some documentation in that area.

[bennothommo]

@SaifurRahmanMohsin What is it that you are trying to achieve? If it's a case of just having tabular data stored in a model, that's already handled by the client-side data table. As long as you have the field for the data table data added to the jsonable attribute, it should be able to save the data from the data table without issue.

If you're trying to store multiple records of a model, that's a little more tricky, and will require you to handle the POST data from the data table manually. You could potentially base it off the implementation of the data table used in the Builder plugin for the Database schema designer.

[mohsin]

@bennothommo I have a custom manager class in a plugin which returns a list of API node paths (string values), exposed by various plugins. I’m trying to set up a data table which allows the list to appear in form of table with additional 2 fields: enabled and auth mechanism (dropdown of available auth schemes to link with that node). When user selects the option, it has to be stored internally so the API manager enforces that throughout the web app.