Skip to content

Commit

Permalink
updated view type docs to show which view they extend from and mentio…
Browse files Browse the repository at this point in the history
…n interactions with regions
  • Loading branch information
Derick Bailey committed Aug 13, 2013
1 parent 22f3365 commit 9f1bb87
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 6 deletions.
8 changes: 8 additions & 0 deletions docs/marionette.collectionview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ specified collection, render each of them using a specified `itemView`,
then append the results of the item view's `el` to the collection view's
`el`.

CollectionView extends directly from Marionette.View. Please see
[the Marionette.View documentation](marionette.view.md)
for more information on available features and functionality.

Additionally, interactions with Marionette.Region
will provide features such as `onShow` callbacks, etc. Please see
[the Region documentation](marionette.region.md) for more information.

## Documentation Index

* [CollectionView's `itemView`](#collectionviews-itemview)
Expand Down
10 changes: 10 additions & 0 deletions docs/marionette.compositeview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ composite view for scenarios where it should represent both a
branch and leaf in a tree structure, or for scenarios where a
collection needs to be rendered within a wrapper template.

Please see
[the Marionette.CollectionView documentation](marionette.collectionview.md)
for more information on available features and functionality.

Additionally, interactions with Marionette.Region
will provide features such as `onShow` callbacks, etc. Please see
[the Region documentation](marionette.region.md) for more information.

## Example Usage: Tree View

For example, if you're rendering a treeview control, you may
want to render a collection view with a model and template so
that it will show a parent item with children in the tree.
Expand Down
8 changes: 8 additions & 0 deletions docs/marionette.itemview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ An `ItemView` is a view that represents a single item. That item may be a
`Backbone.Model` or may be a `Backbone.Collection`. Whichever it is though, it
will be treated as a single item.

ItemView extends directly from Marionette.View. Please see
[the Marionette.View documentation](marionette.view.md)
for more information on available features and functionality.

Additionally, interactions with Marionette.Region
will provide features such as `onShow` callbacks, etc. Please see
[the Region documentation](marionette.region.md) for more information.

## Documentation Index

* [ItemView render](#itemview-render)
Expand Down
17 changes: 11 additions & 6 deletions docs/marionette.layout.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
# Marionette.Layout

A `Layout` is a hybrid of an `ItemView` and a collection of `Region` objects.

They are ideal for rendering application layouts with multiple sub-regions
A `Layout` is a hybrid of an `ItemView` and a collection of `Region` objects. They
are ideal for rendering application layouts with multiple sub-regions
managed by specified region managers.

A layout manager can also act as a composite-view to aggregate multiple
A layout can also act as a composite-view to aggregate multiple
views and sub-application areas of the screen allowing applications to
attach multiple region managers to dynamically rendered HTML.

You can create complex views by nesting layout managers within `Regions`.

Layouts automatically cleanup on closing.

For a more in-depth discussion on Layouts, see the blog post
[Manage Layouts And Nested Views With Backbone.Marionette](http://lostechies.com/derickbailey/2012/03/22/managing-layouts-and-nested-views-with-backbone-marionette/)

Please see
[the Marionette.ItemView documentation](marionette.itemview.md)
for more information on available features and functionality.

Additionally, interactions with Marionette.Region
will provide features such as `onShow` callbacks, etc. Please see
[the Region documentation](marionette.region.md) for more information.

## Documentation Index

* [Basic Usage](#basic-usage)
Expand Down

0 comments on commit 9f1bb87

Please sign in to comment.