comments for docs

This commit is contained in:
vitalets 2013-01-07 12:33:12 +04:00
parent 9db8b9c60d
commit 5ac48f3fd8
8 changed files with 42 additions and 21 deletions

@ -129,16 +129,16 @@ $(function(){
/** /**
@property inputclass @property inputclass
@type string @type string
@default @default null
**/ **/
inputclass: '', inputclass: null,
/** /**
Separator of values when reading from 'data-value' string Separator of values when reading from `data-value` attribute
@property separator @property separator
@type string @type string
@default ', ' @default ','
**/ **/
separator: ',' separator: ','
}); });

@ -128,9 +128,9 @@ $(function(){
tpl:'<div class="editable-date well"></div>', tpl:'<div class="editable-date well"></div>',
/** /**
@property inputclass @property inputclass
@default @default null
**/ **/
inputclass: '', inputclass: null,
/** /**
Format used for sending value to server. Also applied when converting date from <code>data-value</code> attribute.<br> Format used for sending value to server. Also applied when converting date from <code>data-value</code> attribute.<br>
Possible tokens are: <code>d, dd, m, mm, yy, yyyy</code> Possible tokens are: <code>d, dd, m, mm, yy, yyyy</code>

@ -2,6 +2,11 @@
Bootstrap datefield input - modification for inline mode. Bootstrap datefield input - modification for inline mode.
Shows normal <input type="text"> and binds popup datepicker. Shows normal <input type="text"> and binds popup datepicker.
Automatically shown in inline mode. Automatically shown in inline mode.
@class datefield
@extends date
@since 1.4.0
**/ **/
(function ($) { (function ($) {
@ -52,7 +57,6 @@ Automatically shown in inline mode.
DateField.defaults = $.extend({}, $.fn.editabletypes.date.defaults, { DateField.defaults = $.extend({}, $.fn.editabletypes.date.defaults, {
/** /**
@property tpl @property tpl
@default
**/ **/
tpl:'<div class="input-append date"><input type="text"/><span class="add-on"><i class="icon-th"></i></span></div>', tpl:'<div class="input-append date"><input type="text"/><span class="add-on"><i class="icon-th"></i></span></div>',
/** /**

@ -1,7 +1,7 @@
/** /**
jQuery UI Datepicker. jQuery UI Datepicker.
Description and examples: http://jqueryui.com/datepicker. Description and examples: http://jqueryui.com/datepicker.
This input is also accessible as **date** type. Do not use it together with __bootstrap-datepicker__ as both apply <code>$().datepicker()</code> method. This input is also accessible as **date** type. Do not use it together with __bootstrap-datepicker__ as both apply <code>$().datepicker()</code> method.
For **i18n** you should include js file from here: https://github.com/jquery/jquery-ui/tree/master/ui/i18n. For **i18n** you should include js file from here: https://github.com/jquery/jquery-ui/tree/master/ui/i18n.
@class dateui @class dateui
@ -139,9 +139,9 @@ $(function(){
tpl:'<div class="editable-date"></div>', tpl:'<div class="editable-date"></div>',
/** /**
@property inputclass @property inputclass
@default '' @default null
**/ **/
inputclass: '', inputclass: null,
/** /**
Format used for sending value to server. Also applied when converting date from <code>data-value</code> attribute.<br> Format used for sending value to server. Also applied when converting date from <code>data-value</code> attribute.<br>
Full list of tokens: http://docs.jquery.com/UI/Datepicker/formatDate Full list of tokens: http://docs.jquery.com/UI/Datepicker/formatDate

@ -2,6 +2,11 @@
jQuery UI datefield input - modification for inline mode. jQuery UI datefield input - modification for inline mode.
Shows normal <input type="text"> and binds popup datepicker. Shows normal <input type="text"> and binds popup datepicker.
Automatically shown in inline mode. Automatically shown in inline mode.
@class dateuifield
@extends dateui
@since 1.4.0
**/ **/
(function ($) { (function ($) {
@ -48,9 +53,9 @@ Automatically shown in inline mode.
tpl: '<input type="text"/>', tpl: '<input type="text"/>',
/** /**
@property inputclass @property inputclass
@default '' @default null
**/ **/
inputclass: '', inputclass: null,
/* datepicker config */ /* datepicker config */
datepicker: { datepicker: {

@ -254,7 +254,7 @@ List - abstract class for inputs that have source option loaded from js array or
@type string | array | object | function @type string | array | object | function
@default null @default null
**/ **/
source:null, source: null,
/** /**
Data automatically prepended to the beginning of dropdown list. Data automatically prepended to the beginning of dropdown list.
@ -262,7 +262,7 @@ List - abstract class for inputs that have source option loaded from js array or
@type string | array | object | function @type string | array | object | function
@default false @default false
**/ **/
prepend:false, prepend: false,
/** /**
Error message when list cannot be loaded (e.g. ajax error) Error message when list cannot be loaded (e.g. ajax error)

@ -98,7 +98,11 @@ $(function(){
placeholder: null, placeholder: null,
/** /**
Whether to show `clear` button / link or not Whether to show `clear` button
@property clear
@type boolean
@default true
**/ **/
clear: true clear: true
}); });

@ -1,12 +1,19 @@
/** /**
Bootstrap wysihtml5 input Bootstrap wysihtml5 editor.
See https://github.com/jhollingworth/bootstrap-wysihtml5 To use it you should **manually** include required js and css files.
<link rel="stylesheet" type="text/css" href="/css/bootstrap-wysihtml5.css"></link>
<script src="js/wysihtml5-0.3.0.js"></script>
<script src="js/bootstrap-wysihtml5.js"></script>
You can download these files from https://github.com/jhollingworth/bootstrap-wysihtml5
@class wysihtml5 @class wysihtml5
@extends abstractinput @extends abstractinput
@final @final
@since 1.4.0
@example @example
<a href="#" id="comments" data-type="wysihtml5" data-pk="1">awesome comment!</a> <div id="comments" data-type="wysihtml5" data-pk="1"><h2>awesome</h2> comment!</div>
<script> <script>
$(function(){ $(function(){
$('#comments').editable({ $('#comments').editable({
@ -86,9 +93,9 @@ $(function(){
tpl:'<textarea class="editable-wysihtml5"></textarea>', tpl:'<textarea class="editable-wysihtml5"></textarea>',
/** /**
@property inputclass @property inputclass
@default @default null
**/ **/
inputclass: '', inputclass: null,
/** /**
Placeholder attribute of input. Shown when input is empty. Placeholder attribute of input. Shown when input is empty.
@ -106,7 +113,8 @@ $(function(){
**/ **/
rows: 10, rows: 10,
/** /**
Wysihtml5 defaut options Wysihtml5 defaut options.
See https://github.com/jhollingworth/bootstrap-wysihtml5#options
@property wysihtml5 @property wysihtml5
@type object @type object