github-migration/cocoon
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Updated README.

Browse Source
This commit is contained in:
Nathan Van der Auwera 2012-09-21 00:45:42 +02:00
parent 8e3bfa1a29
commit 7baae8f8c3
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.markdown
View File

@ -262,7 +262,14 @@ Optionally you could also leave out the name and supply a block that is captured
### Callbacks (upon insert and remove of items) ### Callbacks (upon insert and remove of items)
There is an option to add a callback on insertion or removal. If in your view you have the following snippet to select an `owner` On insertion or removal the following events are triggered:
* `before-insert.cocoon`: called before inserting a new nested child
* `after-insert.cocoon`: called after inserting
* `before-remove.cocoon`: called before removing the nested child
* `after-remove.cocoon`: called after removal
If in your view you have the following snippet to select an `owner`
(we use slim for demonstration purposes) (we use slim for demonstration purposes)
````haml ````haml
@ -279,17 +286,21 @@ The callbacks can be added as follows:
````javascript ````javascript
$(document).ready(function() { $(document).ready(function() {
$('#owner').bind('insertion-callback', $('#owner').bind('before-insert.cocoon',
function() { function() {
$("#owner_from_list").hide(); $("#owner_from_list").hide();
$("#owner a.add_fields").hide(); $("#owner a.add_fields").hide();
}); });
$('#owner').bind("removal-callback", $('#owner').bind('after-insert.cocoon',
function() {
/* ... do something ... */
});
$('#owner').bind("before-remove.cocoon",
function() { function() {
$("#owner_from_list").show(); $("#owner_from_list").show();
$("#owner a.add_fields").show(); $("#owner a.add_fields").show();
}); });
$('#owner').bind("after-removal-callback", $('#owner').bind("after-remove.cocoon",
function() { function() {
/* e.g. recalculate order of child items */ /* e.g. recalculate order of child items */
}); });
@ -297,7 +308,7 @@ $(document).ready(function() {
```` ````
Do note that for the callbacks to work there has to be a surrounding container (div), where you can bind the callbacks to. Do note that for the callbacks to work there has to be a surrounding container (div), where you can bind the callbacks to.
Note that the default `removal-callback` is called _before_ removing the nested item.
### Control the Insertion behaviour ### Control the Insertion behaviour