Note on expandValue

[mkws-moved-to-github.git] / doc / mkws-developer.markdown

diff --git a/doc/mkws-developer.markdown b/doc/mkws-developer.markdown
index 2689eb6..d4e8162 100644 (file)
--- a/doc/mkws-developer.markdown
+++ b/doc/mkws-developer.markdown
@@ -134,14 +134,25 @@ 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.
+
+* `expandValue()` --
+       TODO: either document this or remove it from the API.
 
 * TODO subwidget()
 
-* TODO expandValue()
-
 In addition to these properties and methods of the bare widget object,
 some kinds of specific widget add other properties of their own. For
 example, the `Builder` widget uses a `callback` property as the
@@ -224,6 +235,13 @@ infelicities reflect the fact that some code that rightly belongs in
 widgets is still in the team. When we finish migrating it, the widget
 API should get simpler.
 
+
+Events
+------
+
+TODO: list of events that can be usefully subscribed to.
+
+
 - - -
 
 Copyright (C) 2013-2014 by IndexData ApS, <http://www.indexdata.com>