From 2e7fec7c481bf4ba1d4eb3e8de120e0840df9415 Mon Sep 17 00:00:00 2001
From: vitalets <noginsk@rambler.ru>
Date: Mon, 4 Feb 2013 00:04:29 +0400
Subject: [PATCH] add comments for value option
---
src/element/editable-element.js | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/src/element/editable-element.js b/src/element/editable-element.js
index c00ab72..2334770 100644
--- a/src/element/editable-element.js
+++ b/src/element/editable-element.js
@@ -598,8 +598,20 @@ Makes editable any HTML element on the page. Applied as jQuery method.
**/
autotext: 'auto',
/**
- Initial value of input. If not set, taken from element's text.
-
+ Initial value of input. If not set, taken from element's text.
+ Note, that if element's text is empty - text is automatically generated from value and can be customized (see `autotext` option).
+ For example, to display currency sign:
+ @example
+ <a id="price" data-type="text" data-value="100"></a>
+ <script>
+ $('#price').editable({
+ ...
+ display: function(value) {
+ $(this).text(value + '$');
+ }
+ })
+ </script>
+
@property value
@type mixed
@default element's text