[doc] added note about the required js and css in TableWidget stable
authorAlexandre Fayolle <alexandre.fayolle@logilab.fr>
Thu, 05 Nov 2009 12:44:24 +0100
branchstable
changeset 3798 d2c27621cc81
parent 3797 af9b0e113108
child 3799 235b341e21bc
[doc] added note about the required js and css in TableWidget
web/htmlwidgets.py
--- a/web/htmlwidgets.py	Thu Nov 05 12:42:15 2009 +0100
+++ b/web/htmlwidgets.py	Thu Nov 05 12:44:24 2009 +0100
@@ -283,7 +283,14 @@
 
 
 class TableWidget(HTMLWidget):
+    """
+    Display data in a Table with sortable column.
 
+    When using remember to include the required css and js with:
+
+    self.req.add_js('jquery.tablesorter.js')
+    self.req.add_css(('cubicweb.tablesorter.css', 'cubicweb.tableview.css'))
+    """
     highlight = "onmouseover=\"addElementClass(this, 'highlighted');\" " \
                 "onmouseout=\"removeElementClass(this, 'highlighted');\""