eventName: (string, required): The eventName to listen to.
+ *node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)
+ *keyCode: (string, optional): If listening for key events, specify the keyCode
+ *By default, this attribute consists of one object which will cause the widget to hide if the + * escape key is pressed.
*/ hideOn: { value: [ diff --git a/build/widget-autohide/widget-autohide.js b/build/widget-autohide/widget-autohide.js index 4cb3b8452fa..510998d292a 100644 --- a/build/widget-autohide/widget-autohide.js +++ b/build/widget-autohide/widget-autohide.js @@ -4,7 +4,7 @@ YUI.add('widget-autohide', function(Y) { * A widget-level extension that provides ability to hide widget when * certain events occur. * - * @module widget-modality + * @module widget-autohide * @author eferraiuolo, tilomitra * @since 3.4.0 */ @@ -27,7 +27,8 @@ var WIDGET_AUTOHIDE = 'widgetAutohide', getCN = Y.ClassNameManager.getClassName; /** - * Widget extension, which can be used to autohide the widget. + * The WidgetAutohide class provides the hideOn attribute which can + * be used to hide the widget when certain events occur. * * @class WidgetAutohide * @param {Object} config User configuration object @@ -61,11 +62,11 @@ WidgetAutohide.ATTRS = { * * @description An array of objects corresponding to the nodes, events, and keycodes to hide the widget on. * The implementer can supply an array of objects, with each object having the following properties: - * eventName: (string, required): The eventName to listen to. - * node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget) - * keyCode: (string, optional): If listening for key events, specify the keyCode - * By default, this attribute consists of one object which will cause the widget to hide if the - * escape key is pressed. + *eventName: (string, required): The eventName to listen to.
+ *node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)
+ *keyCode: (string, optional): If listening for key events, specify the keyCode
+ *By default, this attribute consists of one object which will cause the widget to hide if the + * escape key is pressed.
*/ hideOn: { value: [ diff --git a/build/widget-buttons/widget-buttons-debug.js b/build/widget-buttons/widget-buttons-debug.js index a6ed86ed05a..4bf3fe1c0ce 100644 --- a/build/widget-buttons/widget-buttons-debug.js +++ b/build/widget-buttons/widget-buttons-debug.js @@ -55,13 +55,15 @@ WidgetButtons.ATTRS = { type: "close" } ], - * @description An array of objects, with each object corresponding to a button that you want to be added to the widget. Each button can have upto 4 properties: - * type: {string} Use one of the default buttons provided by the WidgetButtons class. Set this to "close" if you want the - * [x] at the top-right corner of the window. If this key has a value, then values for the remaining properties below don't need to be provided. - * value: {string} HTML string or text that should be shown on the button - * action: {function} The callback function that should be executed when the button is clicked. - * href: {string} (optional) The link to redirect to if the button is clicked> If not supplied, defaults to "#" - * section: {string || object} Whether the button should be placed in the header or footer. Represented as "header" or "footer" + * @descriptionAn array of objects, with each object corresponding to a button that you want to be added to the widget. Each button can have upto 4 properties:
+ * + *type: {string} Use one of the default buttons provided by the WidgetButtons class. Set this to "close" if you want the + * [x] at the top-right corner of the window. If this key has a value, then values for the remaining properties below don't need to be provided.
+ * + *value: {string} HTML string or text that should be shown on the button
+ *action: {function} The callback function that should be executed when the button is clicked.
+ *href: {string} (optional) The link to redirect to if the button is clicked> If not supplied, defaults to "#"
+ *section: {string || object} Whether the button should be placed in the header or footer. Represented as "header" or "footer"
*/ buttons: { @@ -110,9 +112,9 @@ WidgetButtons.BUTTON_CLASS_NAMES = { /** - * Object used to specify the HTML template for the buttons. Consists of the following properties - * defaultTemplate: Specifies the HTML markup for each button - * wrapper: Specifies the HTML markup for the wrapper, which is a DOM Element that wraps around all the buttons + *Object used to specify the HTML template for the buttons. Consists of the following properties
+ *defaultTemplate: Specifies the HTML markup for each button
+ *wrapper: Specifies the HTML markup for the wrapper, which is a DOM Element that wraps around all the buttons
* * @property WidgetButtons.TEMPLATES * @static diff --git a/build/widget-buttons/widget-buttons.js b/build/widget-buttons/widget-buttons.js index 48449376afb..ec0152fbbb9 100644 --- a/build/widget-buttons/widget-buttons.js +++ b/build/widget-buttons/widget-buttons.js @@ -55,13 +55,15 @@ WidgetButtons.ATTRS = { type: "close" } ], - * @description An array of objects, with each object corresponding to a button that you want to be added to the widget. Each button can have upto 4 properties: - * type: {string} Use one of the default buttons provided by the WidgetButtons class. Set this to "close" if you want the - * [x] at the top-right corner of the window. If this key has a value, then values for the remaining properties below don't need to be provided. - * value: {string} HTML string or text that should be shown on the button - * action: {function} The callback function that should be executed when the button is clicked. - * href: {string} (optional) The link to redirect to if the button is clicked> If not supplied, defaults to "#" - * section: {string || object} Whether the button should be placed in the header or footer. Represented as "header" or "footer" + * @descriptionAn array of objects, with each object corresponding to a button that you want to be added to the widget. Each button can have upto 4 properties:
+ * + *type: {string} Use one of the default buttons provided by the WidgetButtons class. Set this to "close" if you want the + * [x] at the top-right corner of the window. If this key has a value, then values for the remaining properties below don't need to be provided.
+ * + *value: {string} HTML string or text that should be shown on the button
+ *action: {function} The callback function that should be executed when the button is clicked.
+ *href: {string} (optional) The link to redirect to if the button is clicked> If not supplied, defaults to "#"
+ *section: {string || object} Whether the button should be placed in the header or footer. Represented as "header" or "footer"
*/ buttons: { @@ -110,9 +112,9 @@ WidgetButtons.BUTTON_CLASS_NAMES = { /** - * Object used to specify the HTML template for the buttons. Consists of the following properties - * defaultTemplate: Specifies the HTML markup for each button - * wrapper: Specifies the HTML markup for the wrapper, which is a DOM Element that wraps around all the buttons + *Object used to specify the HTML template for the buttons. Consists of the following properties
+ *defaultTemplate: Specifies the HTML markup for each button
+ *wrapper: Specifies the HTML markup for the wrapper, which is a DOM Element that wraps around all the buttons
* * @property WidgetButtons.TEMPLATES * @static diff --git a/build/widget-modality/widget-modality-debug.js b/build/widget-modality/widget-modality-debug.js index 4ab272f5481..f6ad9be0e0c 100644 --- a/build/widget-modality/widget-modality-debug.js +++ b/build/widget-modality/widget-modality-debug.js @@ -48,7 +48,7 @@ var WIDGET = 'widget', /** * Widget extension, which can be used to add modality support to the base Widget class, - * through the Base.build method. + * through the Base.create method. * * @class WidgetModality * @param {Object} config User configuration object @@ -112,10 +112,10 @@ var WIDGET = 'widget', * * @description An array of objects corresponding to the nodes and events that will trigger a re-focus back on the widget. * The implementer can supply an array of objects, with each object having the following properties: - * eventName: (string, required): The eventName to listen to. - * node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget) - * By default, this attribute consists of two objects which will cause the widget to re-focus if anything - * outside the widget is clicked on or focussed upon. + *eventName: (string, required): The eventName to listen to.
+ *node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)
+ *By default, this attribute consists of two objects which will cause the widget to re-focus if anything + * outside the widget is clicked on or focussed upon.
*/ focusOn: { value: [ diff --git a/build/widget-modality/widget-modality.js b/build/widget-modality/widget-modality.js index 4ab272f5481..f6ad9be0e0c 100644 --- a/build/widget-modality/widget-modality.js +++ b/build/widget-modality/widget-modality.js @@ -48,7 +48,7 @@ var WIDGET = 'widget', /** * Widget extension, which can be used to add modality support to the base Widget class, - * through the Base.build method. + * through the Base.create method. * * @class WidgetModality * @param {Object} config User configuration object @@ -112,10 +112,10 @@ var WIDGET = 'widget', * * @description An array of objects corresponding to the nodes and events that will trigger a re-focus back on the widget. * The implementer can supply an array of objects, with each object having the following properties: - * eventName: (string, required): The eventName to listen to. - * node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget) - * By default, this attribute consists of two objects which will cause the widget to re-focus if anything - * outside the widget is clicked on or focussed upon. + *eventName: (string, required): The eventName to listen to.
+ *node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)
+ *By default, this attribute consists of two objects which will cause the widget to re-focus if anything + * outside the widget is clicked on or focussed upon.
*/ focusOn: { value: [ diff --git a/src/panel/HISTORY.md b/src/panel/HISTORY.md index 2bd518c9b18..246f14f0c47 100644 --- a/src/panel/HISTORY.md +++ b/src/panel/HISTORY.md @@ -1,5 +1,5 @@ Panel ====== -3.4.0 - Initial Release ------------------------ \ No newline at end of file +3.4.0PR3 - Initial Release +-------------------------- \ No newline at end of file diff --git a/src/panel/README.md b/src/panel/README.md index fa08e109ec9..c0824e36b36 100644 --- a/src/panel/README.md +++ b/src/panel/README.md @@ -1,10 +1,13 @@ -Overlay -======= +Panel +===== -Overlay is a positionable and stackable widget, which also -provides support for the standard module format layout, -with a header, body and footer section. +Panel is a widget that simulates the behavior of an OS window. +It is positionable, stackable, and provides support for the standard +module format layout, with a header, body and footer section. +The header and footer sections can support buttons with specific callback +functions. The panel can be modal, and can be auto-focussed or hidden when +certain UI interactions occur. -The overlay is built by extending Widget and adding the -WidgetPosition, WidgetStack, WidgetPositionAlign, -WidgetPositionConstrain and WidgetStdMod extensions. +The panel is built by extending Widget and adding the WidgetPosition, +WidgetStack, WidgetPositionAlign, WidgetPositionConstrain, WidgetStdMod, +WidgetModality, WidgetAutohide, and WidgetButtons extensions. diff --git a/src/widget-autohide/HISTORY.md b/src/widget-autohide/HISTORY.md new file mode 100644 index 00000000000..6b13ae7467d --- /dev/null +++ b/src/widget-autohide/HISTORY.md @@ -0,0 +1,7 @@ +3.4.0PR3 +-------- + + * Changed from a widget plugin to an extension + +3.4.0PR2 - Initial release +-------------------------- \ No newline at end of file diff --git a/src/widget-autohide/README b/src/widget-autohide/README deleted file mode 100644 index 738271762df..00000000000 --- a/src/widget-autohide/README +++ /dev/null @@ -1,4 +0,0 @@ -A widget level plugin to enable widgets to close based on certain UI interactions. - -3.4.0PR3 - Initial releases - diff --git a/src/widget-autohide/README.md b/src/widget-autohide/README.md new file mode 100644 index 00000000000..b8d1fb71631 --- /dev/null +++ b/src/widget-autohide/README.md @@ -0,0 +1,8 @@ +WidgetAutohide +============== + +WidgetAutohide is a widget-level extension that provides the ability +to hide the widget (through the hide() method) when certain UI interactions +occur, or certain events are fired. It reveals the "hideOn" attribute that +can be configured by a widget subclass implementing this extension. + diff --git a/src/widget-autohide/js/Widget-Autohide.js b/src/widget-autohide/js/Widget-Autohide.js index a50f1edee54..5809b72fc4d 100644 --- a/src/widget-autohide/js/Widget-Autohide.js +++ b/src/widget-autohide/js/Widget-Autohide.js @@ -2,7 +2,7 @@ * A widget-level extension that provides ability to hide widget when * certain events occur. * - * @module widget-modality + * @module widget-autohide * @author eferraiuolo, tilomitra * @since 3.4.0 */ @@ -25,7 +25,8 @@ var WIDGET_AUTOHIDE = 'widgetAutohide', getCN = Y.ClassNameManager.getClassName; /** - * Widget extension, which can be used to autohide the widget. + * The WidgetAutohide class provides the hideOn attribute which can + * be used to hide the widget when certain events occur. * * @class WidgetAutohide * @param {Object} config User configuration object @@ -59,11 +60,11 @@ WidgetAutohide.ATTRS = { * * @description An array of objects corresponding to the nodes, events, and keycodes to hide the widget on. * The implementer can supply an array of objects, with each object having the following properties: - * eventName: (string, required): The eventName to listen to. - * node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget) - * keyCode: (string, optional): If listening for key events, specify the keyCode - * By default, this attribute consists of one object which will cause the widget to hide if the - * escape key is pressed. + *eventName: (string, required): The eventName to listen to.
+ *node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)
+ *keyCode: (string, optional): If listening for key events, specify the keyCode
+ *By default, this attribute consists of one object which will cause the widget to hide if the + * escape key is pressed.
*/ hideOn: { value: [ diff --git a/src/widget-buttons/HISTORY.md b/src/widget-buttons/HISTORY.md new file mode 100644 index 00000000000..6a364145f9d --- /dev/null +++ b/src/widget-buttons/HISTORY.md @@ -0,0 +1,2 @@ +3.4.0PR3 - Initial release +-------------------------- \ No newline at end of file diff --git a/src/widget-buttons/README b/src/widget-buttons/README deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/src/widget-buttons/README.md b/src/widget-buttons/README.md new file mode 100644 index 00000000000..5d50290679f --- /dev/null +++ b/src/widget-buttons/README.md @@ -0,0 +1,11 @@ +WidgetButtons +============= + +WidgetButtons is a widget-level extension that provides the ability +to add buttons to the header and footer sections of a widget that +implements the WidgetStdMod extension. + +Each button can be configured and execute a callback function when clicked. +WidgetButtons reveals the "buttons" attribute that can be configured +by a widget subclass implementing this extension. + diff --git a/src/widget-buttons/js/Widget-Buttons.js b/src/widget-buttons/js/Widget-Buttons.js index 207c926d592..0a2e030ac23 100644 --- a/src/widget-buttons/js/Widget-Buttons.js +++ b/src/widget-buttons/js/Widget-Buttons.js @@ -53,13 +53,15 @@ WidgetButtons.ATTRS = { type: "close" } ], - * @description An array of objects, with each object corresponding to a button that you want to be added to the widget. Each button can have upto 4 properties: - * type: {string} Use one of the default buttons provided by the WidgetButtons class. Set this to "close" if you want the - * [x] at the top-right corner of the window. If this key has a value, then values for the remaining properties below don't need to be provided. - * value: {string} HTML string or text that should be shown on the button - * action: {function} The callback function that should be executed when the button is clicked. - * href: {string} (optional) The link to redirect to if the button is clicked> If not supplied, defaults to "#" - * section: {string || object} Whether the button should be placed in the header or footer. Represented as "header" or "footer" + * @descriptionAn array of objects, with each object corresponding to a button that you want to be added to the widget. Each button can have upto 4 properties:
+ * + *type: {string} Use one of the default buttons provided by the WidgetButtons class. Set this to "close" if you want the + * [x] at the top-right corner of the window. If this key has a value, then values for the remaining properties below don't need to be provided.
+ * + *value: {string} HTML string or text that should be shown on the button
+ *action: {function} The callback function that should be executed when the button is clicked.
+ *href: {string} (optional) The link to redirect to if the button is clicked> If not supplied, defaults to "#"
+ *section: {string || object} Whether the button should be placed in the header or footer. Represented as "header" or "footer"
*/ buttons: { @@ -108,9 +110,9 @@ WidgetButtons.BUTTON_CLASS_NAMES = { /** - * Object used to specify the HTML template for the buttons. Consists of the following properties - * defaultTemplate: Specifies the HTML markup for each button - * wrapper: Specifies the HTML markup for the wrapper, which is a DOM Element that wraps around all the buttons + *Object used to specify the HTML template for the buttons. Consists of the following properties
+ *defaultTemplate: Specifies the HTML markup for each button
+ *wrapper: Specifies the HTML markup for the wrapper, which is a DOM Element that wraps around all the buttons
* * @property WidgetButtons.TEMPLATES * @static diff --git a/src/widget-modality/HISTORY.md b/src/widget-modality/HISTORY.md new file mode 100644 index 00000000000..09a09f916f2 --- /dev/null +++ b/src/widget-modality/HISTORY.md @@ -0,0 +1,10 @@ +WidgetModality +============== + +3.4.0PR3 +-------- + + * Changed from a widget plugin to an extension + +3.4.0PR2 - Initial release +-------------------------- diff --git a/src/widget-modality/README b/src/widget-modality/README deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/src/widget-modality/README.md b/src/widget-modality/README.md new file mode 100644 index 00000000000..c198707dfaf --- /dev/null +++ b/src/widget-modality/README.md @@ -0,0 +1,7 @@ +WidgetModality +============== + +WidgetModality is a widget-level extension that provides modality +and auto-focus support. It implements two new attributes "modal" +and "focusOn" which can be configured by a widget subclass implementing +this extension. diff --git a/src/widget-modality/js/Widget-Modality.js b/src/widget-modality/js/Widget-Modality.js index a4d88ad7692..e33fe4f8041 100644 --- a/src/widget-modality/js/Widget-Modality.js +++ b/src/widget-modality/js/Widget-Modality.js @@ -46,7 +46,7 @@ var WIDGET = 'widget', /** * Widget extension, which can be used to add modality support to the base Widget class, - * through the Base.build method. + * through the Base.create method. * * @class WidgetModality * @param {Object} config User configuration object @@ -110,10 +110,10 @@ var WIDGET = 'widget', * * @description An array of objects corresponding to the nodes and events that will trigger a re-focus back on the widget. * The implementer can supply an array of objects, with each object having the following properties: - * eventName: (string, required): The eventName to listen to. - * node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget) - * By default, this attribute consists of two objects which will cause the widget to re-focus if anything - * outside the widget is clicked on or focussed upon. + *eventName: (string, required): The eventName to listen to.
+ *node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)
+ *By default, this attribute consists of two objects which will cause the widget to re-focus if anything + * outside the widget is clicked on or focussed upon.
*/ focusOn: { value: [ diff --git a/src/widget-position-align/HISTORY.md b/src/widget-position-align/HISTORY.md index cf00dc4e94b..e38b7ab13bd 100644 --- a/src/widget-position-align/HISTORY.md +++ b/src/widget-position-align/HISTORY.md @@ -1,8 +1,16 @@ Widget Position Align ===================== -3.4.0 ------ +3.4.0PR3 +-------- + + * Added "alignOn" attribute which allows the implementer to specify when + the widget should be re-aligned. By default, it re-aligns on window resize + and scroll. + + +3.4.0PR2 +-------- * Widgets are kept in alignment when window is resized or scrolled.