Skip to content

Commit

Permalink
MDL-51228 atto_editor: Add documententation for inlineFormat flag
Browse files Browse the repository at this point in the history
  • Loading branch information
dthies committed Sep 13, 2015
1 parent 8049148 commit beed73a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @return {Node} The Node representing the newly created button.
*/
addButton: function(config) {
Expand Down Expand Up @@ -490,6 +491,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {array} config.entries List of menu entries with the string (entry.text) and the handlers (entry.handler).
* @param {number} [config.overlayWidth=14] The width of the menu. This will be suffixed with the 'em' unit.
* @param {string} [config.menuColor] menu icon background color
Expand Down Expand Up @@ -675,6 +677,7 @@ EditorPluginButtons.prototype = {
* @param {object} config
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {object} [inheritFrom] A parent configuration that this configuration may inherit from.
* @return {object} The normalized configuration
* @private
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @return {Node} The Node representing the newly created button.
*/
addButton: function(config) {
Expand Down Expand Up @@ -488,6 +489,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {array} config.entries List of menu entries with the string (entry.text) and the handlers (entry.handler).
* @param {number} [config.overlayWidth=14] The width of the menu. This will be suffixed with the 'em' unit.
* @param {string} [config.menuColor] menu icon background color
Expand Down Expand Up @@ -673,6 +675,7 @@ EditorPluginButtons.prototype = {
* @param {object} config
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {object} [inheritFrom] A parent configuration that this configuration may inherit from.
* @return {object} The normalized configuration
* @private
Expand Down
3 changes: 3 additions & 0 deletions lib/editor/atto/yui/src/editor/js/editor-plugin-buttons.js
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @return {Node} The Node representing the newly created button.
*/
addButton: function(config) {
Expand Down Expand Up @@ -340,6 +341,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {array} config.entries List of menu entries with the string (entry.text) and the handlers (entry.handler).
* @param {number} [config.overlayWidth=14] The width of the menu. This will be suffixed with the 'em' unit.
* @param {string} [config.menuColor] menu icon background color
Expand Down Expand Up @@ -525,6 +527,7 @@ EditorPluginButtons.prototype = {
* @param {object} config
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {object} [inheritFrom] A parent configuration that this configuration may inherit from.
* @return {object} The normalized configuration
* @private
Expand Down

0 comments on commit beed73a

Please sign in to comment.