fix documentation
This commit is contained in:
parent
f3490dc8d5
commit
6847102507
4 changed files with 29 additions and 33 deletions
|
@ -2,8 +2,7 @@
|
|||
|
||||
/*@
|
||||
Ox.App <f:Ox.Element> Basic application instance that communicates with a JSON API
|
||||
() -> <f> App object
|
||||
(options) -> <f> App object
|
||||
([options]) -> <o> App object
|
||||
options <o> Options object
|
||||
timeout <n> request timeout
|
||||
type <s> HTTP Request type, i.e. 'GET' or 'POST'
|
||||
|
|
|
@ -1,18 +1,14 @@
|
|||
'use strict';
|
||||
|
||||
/*@
|
||||
Ox.List <f:Ox.Container> List Element
|
||||
([options[, self]]) -> <f> List Object
|
||||
Ox.List <f:Ox.Container> List constructor
|
||||
options <o> Options object
|
||||
centered <b|false> if true, and orientation is 'horizontal',
|
||||
then keep the selected item centered
|
||||
centered <b|false> if true, and orientation is 'horizontal', then keep the selected item centered
|
||||
construct <f|null> (data) returns the list item HTML
|
||||
draggable <b|false> If true, items can be dragged
|
||||
format <[]> ???
|
||||
itemHeight <n|16> item height
|
||||
items <a|f|null> <a> list of items,
|
||||
<f> (data) returns {items, size, ...}
|
||||
(data, callback) returns [items]
|
||||
items <a|f|null> <a> list of items, <f> (data) returns {items, size, ...}, (data, callback) returns [items]
|
||||
itemWidth <n|16> item width
|
||||
keys <a|[]> keys of the list items
|
||||
max <n|-1> Maximum number of items that can be selected (-1 for all)
|
||||
|
@ -22,25 +18,26 @@ Ox.List <f:Ox.Container> List Element
|
|||
selected <a|[]> ids of the selected elements
|
||||
sort <a|[]> sort order
|
||||
sortable <b|false> If true, items can be re-ordered
|
||||
sums <[]|[]> sums to be included in totals
|
||||
type <s|'text'>
|
||||
sums <[s]|[]> sums to be included in totals
|
||||
type <s|'text'> type
|
||||
unique <s|''> name of the key that acts as unique id
|
||||
self <o> shared private variable
|
||||
add <!> item added
|
||||
delete <!> item removed
|
||||
draganddrop <!> Fires during drag
|
||||
draganddropend <!> Fires on drop
|
||||
draganddropenter <!> Fires when entering an item during drag
|
||||
draganddropleave <!> Fires when leaving an item during drag
|
||||
draganddroppause <!> Fires when the mouse stops during drag
|
||||
draganddropstart <i> Fires when drag starts
|
||||
copy <!> copy
|
||||
paste <!> paste
|
||||
move <!> move item
|
||||
load <!> list loaded
|
||||
openpreview <!> preview of selected item opened
|
||||
closepreview <!> preview closed
|
||||
select <!> select item
|
||||
([options[, self]]) -> <o> List object
|
||||
add <!> item added
|
||||
delete <!> item removed
|
||||
draganddrop <!> Fires during drag
|
||||
draganddropend <!> Fires on drop
|
||||
draganddropenter <!> Fires when entering an item during drag
|
||||
draganddropleave <!> Fires when leaving an item during drag
|
||||
draganddroppause <!> Fires when the mouse stops during drag
|
||||
draganddropstart <i> Fires when drag starts
|
||||
copy <!> copy
|
||||
paste <!> paste
|
||||
move <!> move item
|
||||
load <!> list loaded
|
||||
openpreview <!> preview of selected item opened
|
||||
closepreview <!> preview closed
|
||||
select <!> select item
|
||||
@*/
|
||||
|
||||
// fixme: rename the add event to new, or the delete event to remove
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/*@
|
||||
Ox.TextList <f:Ox.Element> TextList Object
|
||||
([options[, self]]) -> <f> TextList Object
|
||||
([options[, self]]) -> <o> TextList Object
|
||||
options <o> Options object
|
||||
columns <[o]|[]> Columns
|
||||
# Fixme: There's probably more...
|
||||
|
@ -25,17 +25,17 @@ Ox.TextList <f:Ox.Element> TextList Object
|
|||
columnsVisible <b|false> If true, columns are visible
|
||||
columnWidth <[n]|[40, 800]> Minimum and maximum column width
|
||||
draggable <b|false> If true, items can be dragged
|
||||
id <s|''>
|
||||
id <s|''> Id
|
||||
items <f|null> function() {} {sort, range, keys, callback} or array
|
||||
keys <[s]|[]> Additional keys (apart from keys of visible columns)
|
||||
max <n|-1> Maximum number of items that can be selected (-1 for all)
|
||||
min <n|0> Minimum number of items that must be selected
|
||||
pageLength <n|100> Number of items per page
|
||||
scrollbarVisible <b|false> If true, the scrollbar is always visible
|
||||
selected <a|[]>
|
||||
sort <[]|[]>
|
||||
selected <[s]|[]> Array of selected ids
|
||||
sort <[o]|[s]|[]> ['+foo', ...] or [{key: 'foo', operator: '+'}, ...]
|
||||
sortable <b|false> If true, elements can be re-ordered
|
||||
sums <[]|[]> Sums to be included in totals
|
||||
sums <[s]|[]> Sums to be included in totals
|
||||
self <o> shared private variable
|
||||
@*/
|
||||
|
||||
|
|
|
@ -137,8 +137,8 @@ Ox.load = function() {
|
|||
};
|
||||
|
||||
/*@
|
||||
Ox.localStorage <o> localStorage wrapper
|
||||
(namespace) -> <f> localStorage object for a given namespace
|
||||
Ox.localStorage <f> localStorage wrapper
|
||||
(namespace) -> storage <f> localStorage function for a given namespace
|
||||
FIXME: there is a bug in Ox.doc here,
|
||||
will use "(namespace)" as function name
|
||||
() -> <o> returns all key:value pairs
|
||||
|
|
Loading…
Reference in a new issue