X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-developer.markdown;h=f672f894516b16aed3ad4712ed5ffc6c3db44294;hb=c5f73fee3834e72bc7abe61f020ce129b864f660;hp=6bbe48a286d6595651fdf519c26518eda986b393;hpb=61f2c05aa0769707527886d556ddf4045cfdf84f;p=mkws-moved-to-github.git diff --git a/doc/mkws-developer.markdown b/doc/mkws-developer.markdown index 6bbe48a..f672f89 100644 --- a/doc/mkws-developer.markdown +++ b/doc/mkws-developer.markdown @@ -180,7 +180,8 @@ that is passed into `registerWidgetType`'s callback function, and can be used by the derived widget. * `String this.type` -- - A string containing the type of the widget. + A string containing the type of the widget (`search`, + `switch`, etc.) * `Team this.team` -- The team object to which this widget belongs. The team has @@ -188,7 +189,8 @@ be used by the derived widget. below. * `DOMElement this.node` -- - The DOM element of the widget + The DOM element of the widget. Most often used for inserting + HTML into the widget element. * `Hash this.config` -- A table of configuration values for the widget. This table @@ -197,7 +199,7 @@ be used by the derived widget. inherits from the default configuration. Instances of widgets in HTML can set configuration items as HTML attributes: for example, the HTML element - `
`. + `
` creates a widget for which `this.config.maxrecs` is set to 10. * `String this.toString()` -- @@ -219,16 +221,6 @@ be used by the derived widget. 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. - * `subwidget(type, overrides, defaults)` -- Returns the HTML of a subwidget of the specified type, which can then be inserted into the widget using the @@ -242,7 +234,7 @@ be used by the derived widget. See for example the `Credo` widget defined in the example area's `mkws-widget-credo.js` file. This uses several invocations of `subwidget` to create a complex compound widget - with numerous text, facet and image panes. TODO: rename this + with numerous text, facet and image panes. FIXME: rename this widget and everything related to it. In addition to these properties and methods of the bare widget object, @@ -331,7 +323,7 @@ API should get simpler. Events ------ -TODO: list of events that can be usefully subscribed to. +FIXME: list of events that can be usefully subscribed to. - - -