lib/yui/button/README

   1 *** Version 2.3.0 ***
   2
   3 Added the following features:
   4 -----------------------------
   5
   6 + Added a "focusmenu" configuration attribute that controls whether or not a
   7   Button instance's menu will automatically be focused when made visible.
   8
   9 + Added a "lazyloadmenu" configuration attribute that controls the value of
  10   the "lazyload" configuration property of a Button's menu.
  11
  12 + Added "menuclassname" configuration attribute that defines a CSS class name
  13   to be applied to the root HTML element of a button's menu.
  14
  15
  16 Fixed the following bugs:
  17 -------------------------
  18
  19 + Setting the "label" attribute of a Button of type "link" to a string with
  20   a "www." prefix will no longer result in the value of the "href" property
  21   being used for the "label" in IE.
  22
  23 + Disabling a Button when its menu is visible will now result in the menu
  24   being hidden.
  25
  26 + Hidden field(s) created by a Button instance are now removed if the
  27   submission of its parent form is cancelled.
  28
  29 + If a Button instance is preceeded by another enabled HTML submit button
  30   (<input type="submit" ...> or <button type="submit" ...>), it will no longer
  31   create a hidden field representing its name and value when its parent form
  32   is submitted.
  33
  34 + If an HTML form contains a mix of YUI Buttons of type "submit" and standard
  35   HTML submit buttons (<input type="submit" ...> or <button type="submit" ...>)
  36   its "submit" event will no longer fire twice when it is submitted by the user
  37   pressing the enter key while focus inside another HTML form control.
  38
  39 + If all Button instances in a form are disabled, the form will no longer be
  40   submitted when the user presses the enter key while focused inside another
  41   HTML form control.
  42
  43 + The first enabled Button instance in a form now correctly adds its name and
  44   value to the form's data set when the form is submitted by the user pressing
  45   the enter key while focused inside another form control.
  46
  47 + Fixed typo in the source file for the ButtonGroup class that was causing the
  48   private variable "m_oButtons" to be declared as a global.
  49
  50 + Switched to use of the CSS display type "-moz-inline-box" from
  51   "-moz-inline-stack" for Gecko-based browsers so that the entire area of a
  52   Button instance is clickable when it is rendered inside another inline
  53   element.
  54
  55 + Added "yui-button" and "yui-[button type]-button" prefix to CSS classes to
  56   sandbox Button styles.
  57
  58
  59 Changes:
  60 --------
  61
  62 + Default value of "type" configuration attribute now "push" (was "button").
  63
  64 + Type "menubutton" now "menu."
  65
  66 + Type "splitbuton" now "split."
  67
  68 + Added "addStateCSSClasses" method.
  69
  70 + Added "removeStateCSSClasses" method.
  71
  72 + Renamed protected property "_hiddenField" to "_hiddenFields."
  73
  74 + Removed protected "submit" event handler named "_onFormSubmit."
  75
  76 + Renamed public method "createHiddenField" to "createHiddenFields."
  77
  78 + Added new "removeHiddenFields" method.
  79
  80 + Renamed static method "YAHOO.widget.Button.onFormKeyDown"
  81   to "YAHOO.widget.Button.onFormKeyPress."
  82
  83 + Renamed "TAG_NAME" constant (YAHOO.widget.Button.prototype.TAG_NAME and
  84   YAHOO.widget.ButtonGroup.prototype.TAG_NAME) to
  85   "NODE_NAME" (YAHOO.widget.Button.prototype.NODE_NAME and
  86   YAHOO.widget.ButtonGroup.prototype.NODE_NAME).
  87
  88 + The "selectedMenuItem" configuration attribute now correctly gets/sets the
  89   index of the selected MenuItem instance of the button's menu, rather than a
  90   MenuItem instance.
  91
  92 + The "container" configuration attribute is now writeonce
  93
  94 + The "menu" configuration attribute is now writeonce
  95
  96 + The root element of each button's menu now will have two CSS classes
  97   appended to it:
  98     - The CSS class name specified by the "menuclassname" configuration
  99       attribute (by default is "yui-button-menu")
 100     - A type-specific class name (either "yui-split-button-menu"
 101       or "yui-menu-button-menu")
 102
 103 + "menu" configuration attribute now supports creation or use of
 104   YAHOO.widget.Overlay in addition to previously supported
 105   YAHOO.widget.Menu:
 106
 107         - To create a menu from existing markup using YAHOO.widget.Overlay, pass the
 108           id or node reference of the HTML element to be used to create the Overlay
 109           as the value of the "menu" configuration attribute.
 110
 111     - YAHOO.widget.Overlay instances passed as a value for the "menu"
 112       configuration attribute need to be fully rendered.
 113
 114         - To create a menu from existing markup using YAHOO.widget.Menu, pass the
 115           id or node reference of the HTML element to be used to create the menu
 116           as the value of the "menu" configuration attribute and give the
 117           HTML element the same class name as specified by
 118           YAHOO.widget.Menu.prototype.CSS_CLASS_NAME.
 119
 120         - YAHOO.widget.Overlay instances used as a menu are by default not rendered
 121           until they are are made visible for the first time.  This behavior
 122           can be changed so that they are rendered immediately by setting the value
 123           of the "lazyloadmenu" configuration attribute to "false."
 124
 125 + If you pass an element id for the value of the "menu" configuration
 126   attribute, that node is now accessed immediately via the "get" method of the
 127   Dom utility (YAHOO.util.Dom) as opposed to the "onContentReady" method of the
 128   Event utility (YAHOO.util.Event).
 129
 130 + Modified code to support a more generic markup format.  Now any number of
 131   HTML elements can exist between a Button's root HTML element and its button
 132   node (be it an <A> or <BUTTON> element):
 133
 134     <ROOT_NODE> ... <BUTTON_NODE /> ... </ROOT_NODE>
 135
 136 + A Button can now be initialized using any of the following six HTML patterns:
 137
 138     - <A> TEXT/HTML </A>
 139     - <BUTTON> TEXT/HTML </BUTTON>
 140     - <INPUT />
 141     - <ROOT_NODE> ... <A> TEXT/HTML </A> ... </ROOT_NODE>
 142     - <ROOT_NODE> ... <BUTTON> TEXT/HTML </BUTTON> ... </ROOT_NODE>
 143     - <ROOT_NODE> ... <INPUT /> ... </ROOT_NODE>
 144
 145 + The id of a Button instance can now match that of its source element.
 146
 147 + CSS changes:
 148
 149     1) All Buttons have a "yui-" prefix as opposed to "yui":
 150
 151     2.2.2           | 2.3
 152     -------------------------
 153     .yuibutton  | .yui-button
 154
 155
 156     2) Each Button type has its own class name with a "yui-" prefix and
 157     "-button" suffix IN ADDITION TO the default "yui-button" class name:
 158
 159     2.2.2                       | 2.3
 160     ------------------------------------------
 161     .yuibutton.splitbutton      | .yui-split-button
 162     .yuibutton.menubutton       | .yui-menu-button
 163
 164     * Allows for the definition of generic styles that apply to all buttons,
 165     while providing a means for uniquely styling buttons of a specific type.
 166
 167
 168     3) For states that are common to all Buttons, two classes are applied: a
 169     generic class name (i.e. yui-button-[state]) and a type-specific state class
 170     name (yui-[type]-button-[state]):
 171
 172     2.2.2                       | 2.3
 173     -------------------------------------------
 174     .yuibutton.focus    | .yui-button-focus
 175     .yuibutton.radio.focus      | .yui-radio-button-focus
 176
 177     * States common to all Button types are:
 178         + focus
 179         + hover
 180         + active
 181         + disabled
 182
 183     ** Allows for the definition of generic styles that apply to all states of
 184     all buttons, while providing a means for uniquely styling states for
 185     buttons of a specific type.
 186
 187
 188     4) Buttons of type "radio" and "checkbox" have two classes applied to
 189     represent their "checked" state: a generic class name
 190     (i.e. yui-button-checked) and a type-specific class
 191     name (yui-[type]-button-checked):
 192
 193     2.2.2                           | 2.3
 194     -------------------------------------------
 195     .yuibutton.checked      | .yui-button-checked
 196     .yuibutton.radio.checked    | .yui-radio-button-checked
 197     .yuibutton.checkbox.checked | .yui-checkbox-button-checked
 198
 199     ** This allows for the definition of a universal style for all Buttons that
 200     have a "checked" state or the ability to define a type-specific style for
 201     the "checked" state.
 202
 203
 204     5) States that are specific to a particular type only get a type-specific
 205     state class name.  Currently this only applies to the "splitbutton" type:
 206
 207     2.2.2                           | 2.3
 208     -------------------------------------------
 209     .yuibutton.activeoption     | .yui-split-button-activeoption
 210
 211
 212     6) The "ie6" class name is removed.
 213
 214
 215 *** Version 2.2.2 ***
 216
 217 + No changes
 218
 219
 220 *** Version 2.2.1 ***
 221
 222 Added the following features:
 223 -----------------------------
 224
 225 + Added "getHiddenField" method to YAHOO.widget.Button.
 226
 227
 228 Fixed the following bugs:
 229 -------------------------
 230
 231 + Removed built-in use of the Event utility's "onAvailable" method from the
 232   constructor of Button and ButtonGroup as it was preventing the addition of
 233   event listeners on instances created from existing markup.  Going forward
 234   Button and ButtonGroup instances created from existing markup can only be
 235   instantiated once their source HTML element is available in the DOM.  The
 236   Button examples illustrate how this can be accomplished.
 237
 238 + Modified code so that disabled Button instances no longer fire DOM events.
 239
 240 + Pressing the enter key while focused on a form field whose parent form
 241   contains a Button instance of type "submit" will now automatically submit
 242   the form using the first Button instance of type "submit".
 243
 244 + Clicking a Button instance of type="submit" will now cause the Button's
 245   parent form's "submit" event to fire.
 246
 247 + Modified Button CSS so that the filter used to apply alpha transparency to
 248   a Button's background PNG is only used by IE 6.  The previous code was
 249   enabling IE's Alpha image loader for IE 7 in Quirks mode.
 250
 251 + Fixed documentation error for "getForm" method.
 252
 253
 254 Changes:
 255 --------
 256
 257 + Made the "submitForm" method of YAHOO.widget.Button public (was
 258   previously protected).
 259
 260 + Removed "init" event and corresponding "oninit" configuration attribute
 261   from YAHOO.widget.Button and YAHOO.widget.ButtonGroup.
 262
 263 + Added the CSS class "ie6" to button.css.  This classname is append to root
 264   DOM element of Button instances created with IE 6.  By default this class
 265   is used to apply a filter that gives alpha transparency to a Button's
 266   background PNG.
 267
 268
 269
 270 *** Version 2.2.0 ***
 271
 272 * Button Control introduced