Skip to content

Commit 8a7236f

Browse files
committed
Doc: changed screenshots + additions to views methods..
Added doc.js for views API.
1 parent f526720 commit 8a7236f

25 files changed

Lines changed: 524 additions & 157 deletions

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,39 +46,39 @@ var vw = new Evol.ViewOne.View(myConfig);
4646
This view shows all fields for edition to create or update models.
4747
It automatically performs validation based on the UI-model and supports the Master-Details pattern (nested collections).
4848
Fields are grouped in panels and tabs.
49-
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/one-edit.png)
49+
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/one-edit.gif)
5050
```javascript
5151
var vw = new Evol.ViewOne.Edit(myConfig);
5252
```
5353
### Mini (Quick Edit)
5454
Only shows important fields (required or showing as a column in grids). Fields are grouped in a single panel.
55-
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/one-mini.png)
55+
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/one-mini.gif)
5656
```javascript
5757
var vw = new Evol.ViewOne.Mini(myConfig);
5858
```
5959
### JSON
6060
JSON representation of the data.
61-
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/one-json.png)
61+
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/one-json.gif)
6262
```javascript
6363
var vw = new Evol.ViewOne.JSON(myConfig);
6464
```
6565

6666
## Views for a collection of Many models
6767
### List
6868
Gives a tabular view of a collection with paging.
69-
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/many-list.png)
69+
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/many-list.gif)
7070
```javascript
7171
var vw = new Evol.ViewMany.List(myConfig);
7272
```
7373
### Cards
7474
Shows records side by side as cards.
75-
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/many-cards.png)
75+
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/many-cards.gif)
7676
```javascript
7777
var vw = new Evol.ViewMany.Cards(myConfig);
7878
```
7979
### Charts
8080
Draws charts about the collection.
81-
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/many-charts.png)
81+
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/many-charts.gif)
8282
```javascript
8383
var vw = new Evol.ViewMany.Charts(myConfig);
8484
```
@@ -87,13 +87,13 @@ var vw = new Evol.ViewMany.Charts(myConfig);
8787
Backbone Views for actions on a collection or a model.
8888
### Export
8989
View to define export options and preview the collection export in different data formats (CSV, TAB, HTML, XML, SQL and JSON).
90-
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/action-export.png)
90+
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/action-export.gif)
9191
```javascript
9292
var vw = new Evol.ViewAction.Export(myConfig);
9393
```
9494
### Filter
9595
View used to build a structured query to filter a collection.
96-
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/action-filter.png)
96+
![screenshot 1](https://raw.githubusercontent.com/evoluteur/evolutility/master/doc/screenshots/action-filter.gif)
9797
```javascript
9898
var vw = new Evol.ViewAction.Filter(myConfig);
9999
```
@@ -122,14 +122,17 @@ var UIModel_todo = {
122122
type: 'panel', label: 'Task', width: 62,
123123
elements: [
124124
{
125-
id: 'title', type: 'text', label: 'Title', required: true,
126-
maxlength: 255, width: 100, viewmany: true
125+
id: 'title', type: 'text', label: 'Title',
126+
required: true, maxlength: 255,
127+
width: 100, viewmany: true
127128
},
128129
{
129-
id: 'duedate', type: 'date', label: 'Due Date', width: 62, viewmany: true
130+
id: 'duedate', type: 'date', label: 'Due Date',
131+
width: 62, viewmany: true
130132
},
131133
{
132-
id: 'category', type: 'lov', label: 'Category', width: 38, viewmany: true,
134+
id: 'category', type: 'lov', label: 'Category',
135+
width: 38, viewmany: true,
133136
list: [
134137
{id: 'home', text: 'Home'},
135138
{id: 'work', text: 'Work'},
@@ -155,15 +158,19 @@ var UIModel_todo = {
155158
]
156159
},
157160
{
158-
id: 'complete', type: 'boolean', label: 'Complete', width: 100, viewmany: true
161+
id: 'complete', type: 'boolean', label: 'Complete',
162+
width: 100, viewmany: true
159163
}
160164
]
161165
},
162166
{
163167
type: 'panel', label: 'Notes', width: 100,
164168
elements: [
165-
{id: 'notes', type: 'textmultiline', label: 'Notes', maxlength: 1000,
166-
width: 100, height: 6, viewmany: false }
169+
{
170+
id: 'notes', type: 'textmultiline', label: 'Notes',
171+
maxlength: 1000,
172+
width: 100, height: 6, viewmany: false
173+
}
167174
]
168175
}
169176
]

doc/screenshots/action-export.gif

24.1 KB
Loading

doc/screenshots/action-export.png

-132 KB
Binary file not shown.

doc/screenshots/action-filter.gif

5.25 KB
Loading

doc/screenshots/action-filter.png

-41.5 KB
Binary file not shown.

doc/screenshots/many-cards.gif

61.6 KB
Loading

doc/screenshots/many-cards.png

-83.5 KB
Binary file not shown.

doc/screenshots/many-charts.gif

18.5 KB
Loading

doc/screenshots/many-charts.png

-100 KB
Binary file not shown.

doc/screenshots/many-list.gif

30.8 KB
Loading

0 commit comments

Comments
 (0)