hyperform icon indicating copy to clipboard operation
hyperform copied to clipboard

Documentation of full API

Open Nettsentrisk opened this issue 8 years ago • 3 comments

Are there plans to document the API?

  • addTranslation
  • setRenderer
  • etc.

Nettsentrisk avatar Mar 01 '17 13:03 Nettsentrisk

Plans, yes. Time, no :cry:. The idea is to replace the "High-Level API" document with a more structured approach: Which configuration parameters are possible, which methods do hyperform and the wrapper hyperform(window) expose, and so on.

Thanks for the ticket! I'll try to make time to get this thing out of the door soon. It's clear to me, that a library is mostly only as good as its documentation.

Boldewyn avatar Mar 01 '17 14:03 Boldewyn

Note to self: Don't forget to document the hooks infrastructure.

Boldewyn avatar Mar 01 '17 14:03 Boldewyn

Would also love to see an example of how to use hyperform with a validation rule that is dependent on an AJAX request.

Nettsentrisk avatar Sep 27 '17 11:09 Nettsentrisk