Document the widget methods autosearch() and hideWhenNarrow().
authorMike Taylor <mike@indexdata.com>
Mon, 11 Aug 2014 13:15:38 +0000 (14:15 +0100)
committerMike Taylor <mike@indexdata.com>
Mon, 11 Aug 2014 13:15:38 +0000 (14:15 +0100)
Still to do: subwidget() and expandValue().

doc/mkws-developer.markdown

index 2689eb6..367611b 100644 (file)
@@ -134,9 +134,19 @@ be used by the derived widget.
 * `String this.value()` --
        A function returning the value of the widget's HTML element.
 
-* TODO autosearch()
-
-* TODO hideWhenNarrow()
+* `VOID autosearch()` --
+       Registers that this kind of widget is one that requires an
+       automatic search to be run for it if an `autosearch` attribute
+       is provided on the HTML element. This is appropriate for
+       widgets such as `Records` and `Facet` that display some part
+       of a search result.
+
+* `VOID hideWhenNarrow()` --
+       Registers that this widget should hide itself when the page
+       becomes "narrow" -- that is, fewer pixels in width that the
+       threshhold value specified by the top-level configuration item
+       `responsive_design_width`. Should be used for "unimportant"
+       widgets that can be omitted from the mobile version of a site.
 
 * TODO subwidget()