Kmenger has uploaded a new change for review.
https://gerrit.wikimedia.org/r/192348
Change subject: IconElement: Add description for config options
......................................................................
IconElement: Add description for config options
Change-Id: I21d1532d382562d84f74706975807b16dc822b8c
---
M src/elements/IconElement.js
1 file changed, 23 insertions(+), 5 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/48/192348/1
diff --git a/src/elements/IconElement.js b/src/elements/IconElement.js
index e5ba688..8634815 100644
--- a/src/elements/IconElement.js
+++ b/src/elements/IconElement.js
@@ -12,11 +12,29 @@
*
* @constructor
* @param {Object} [config] Configuration options
- * @cfg {jQuery} [$icon] Icon node, assigned to #$icon, omit to use a
generated `<span>`
- * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names
keyed by language ID;
- * use the 'default' key to specify the icon to be used when there is no icon
in the user's
- * language
- * @cfg {string} [iconTitle] Icon title text or a function that returns text
+ * @cfg {jQuery} [$icon] The icon element created by the class. If this
configuration is omitted,
+ * the icon element will use a generated `<span>`. To use a different HTML
tag, or to specify that
+ * the icon element be set to an existing icon instead of the one generated
by this class, set a
+ * value using a jQuery selection. For example:
+ *
+ * // Use a <div> tag instead of a <span>
+ * $icon: $("<div>")
+ * // Use an existing icon element instead of the one generated by the
class
+ * $icon: this.$element
+ * // Use an icon element from a child widget
+ * $icon: this.childwidget.$element
+ * @cfg {Object|string} [icon=''] The symbolic name of the icon (e.g.,
‘remove’ or ‘menu’), or a map of
+ * symbolic names. A map is used for i18n purposes and contains a `default`
icon
+ * name and additional names keyed by language code. The `default` name is
used when no icon is keyed
+ * by the user's language.
+ *
+ * Example of an i18n map:
+ *
+ * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
+ * See the [OOjs UI documentation on MediaWiki] [2] for a list of icons
included in the library.
+ * [2]:
https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Icons
+ * @cfg {string|Function} [iconTitle] A text string used as the icon title, or
a function that returns title
+ * text. The icon title is displayed when users move the mouse over the icon.
*/
OO.ui.IconElement = function OoUiIconElement( config ) {
// Configuration initialization
--
To view, visit https://gerrit.wikimedia.org/r/192348
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I21d1532d382562d84f74706975807b16dc822b8c
Gerrit-PatchSet: 1
Gerrit-Project: oojs/ui
Gerrit-Branch: master
Gerrit-Owner: Kmenger <kmen...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
