Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dallas/node22 #117

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 33 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,24 @@
NOTE: I no longer have time to maintain this module. Please see the forks list for actively maintained projects, such as https://github.com/kahwee/backbone-deep-model

backbone-deep-model
===================
# backbone-deep-model

Improved support for models with nested attributes.

Allows you to get and set nested attributes with path syntax, e.g. `user.type`.

Triggers change events for changes on nested attributes.

Dependencies
============
# Dependencies

Backbone >= 0.9.10
Underscore >= 1.8.2

Installation
============
# Installation

1. Include Backbone and it's dependencies in your page/app.
2. Include `distribution/deep-model.min.js`

Usage
=====
# Usage

Then just have your models extend from Backbone.DeepModel instead of Backbone.Model.

Expand All @@ -42,81 +39,87 @@ Example code:
{ name: 'Cyrril' }
]
});

//You can bind to change events on nested attributes
model.bind('change:user.name.first', function(model, val) {
console.log(val);
});

//Wildcards are supported
model.bind('change:user.*', function() {});

//Use set with a path name for nested attributes
//NOTE you must you quotation marks around the key name when using a path
model.set({
'user.name.first': 'Lana',
'user.name.last': 'Kang'
});

//Use get() with path names so you can create getters later
console.log(model.get('user.type')); // 'Spy'

//You can use index notation to fetch from arrays
console.log(model.get('otherSpies.0.name')) //'Lana'

Author
======
# Author

Charles Davison - [powmedia](http://github.com/powmedia)


Contributors
============
# Contributors

- [mattyway](https://github.com/mattyway)
- [AsaAyers](https://github.com/AsaAyers)


Changelog
=========
# Changelog

master:

- Add supprt for arrays in nested attributes (sqren)

0.11.0:
0.11.0:

- Trigger change events only once (restorer)

0.10.4:
0.10.4:

- Fix #68 Model or collection in attributes are eliminated when defaults are used

0.10.0:
0.10.0:

- Support Backbone 0.9.10

0.9.0:
0.9.0:

- Support Backbone 0.9.9 (mattyway)
- Add support for deep model defaults (mattyway)

0.8.0:
0.8.0:

- Allow nested attribute as Model identifier (milosdakic)
- Add AMD support (drd0rk)
- Added "change:*" event triggers for ancestors of nested attributes. (jessehouchins)
- Added "change:\*" event triggers for ancestors of nested attributes. (jessehouchins)
- JSHint linting (tony)
- Fix: undefined in setNested resulting from a recent change in backbone master. (evadnoob)

0.7.4:
0.7.4:

- Fix: #22 model.hasChanged() is not reset after change event fires
- Fix: #18 Setting a deep property to the same value deletes the property (mikefrey)
- Allow setting nested attributes inside an attribute whose value is currently null (sqs)

0.7.3:
0.7.3:

- Add DeepModel.keyPathSeparator to allow using custom path separators

0.7.2:
0.7.2:

- Check if the child object exists, but isn't an object. #12 (tgriesser)

0.7.1:
0.7.1:

- Model.changedAttributes now works with nested attributes.
- Fix getting attribute that is an empty object

0.7:
0.7:

- Update for Backbone v0.9.2
Loading