Skip to content
This repository has been archived by the owner on Dec 2, 2021. It is now read-only.

Commit

Permalink
Small fixes to docs (links)
Browse files Browse the repository at this point in the history
  • Loading branch information
IjzerenHein committed Dec 1, 2014
1 parent 42a3296 commit ce9b68d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 35 deletions.
32 changes: 1 addition & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,37 +240,7 @@ FlexScrollView is a flexible and highly performant scroll-view for famo.us suppo

It is based on [ScrollController](docs/ScrollController.md) which implements the core functionality of the scroll-view, which is turn is inherited from [LayoutController](docs/LayoutController.md).

### [Full FlexScrollView Tutorial](tutorials/FlexScrollView.md)

```javascript
var FlexScrollView = require('famous-flex/ScrollView');
//var CollectionLayout = require('famous-flex/layouts/CollectionLayout');
var RefreshLoader = require('famous-refresh-loader/RefreshLoader');

var scrollView = new FlexScrollView({
//layout: CollectionLayout, // uncomment to enable collection-layouts
layoutOptions: {
margins: [10, 20, 10, 20], // margins supported by ListLayout
spacing: [5, 20], // spacing between list-items
isHeaderCallback: function(node) {
return node.isHeader; // see Tutorial for details!
}
},
flow: true, // true enables smooth flowing
direction: 0, // 0: horizontal, 1: vertical
alignment: 0, // set to 1 for bottom/right alignment
useContainer: false, // set to true to auto-embed in a ContainerSurface
mouseMove: true, // allow hold and move using the mouse
autoPipeEvents: true, // automatically call .pipe when renderable is inserted
pullToRefreshHeader: new RefreshLoader() // enable pull to refresh
});
this.add(scrollView);

// add renderables
for (var i = 0; i < 50; i++) {
scrollView.push(new Surface({content: 'my surface'}));
}
```
### Take the [FlexScrollView Tutorial](tutorials/FlexScrollView.md)


## Standard layouts
Expand Down
8 changes: 4 additions & 4 deletions tutorials/FlexScrollView.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ FlexScrollView

FlexScrollView is a high performance scroll-view for famo.us based on the famous-flex LayoutController technology. The scrollview separates the actual layout algorithm from the scrollview, making it possible to select any layout into the scrollview.

By default FlexScrollView uses the [ListLayout](../docs/layouts/ListLayout.md) layout, which supports features such as [sticky headers](#sticky-headers) and [margins & spacing](#margins--spacing-listlayout).
By default FlexScrollView uses the [ListLayout](../docs/layouts/ListLayout.md) layout, which supports features such as [sticky headers](#sticky-headers-listlayout) and [margins & spacing](#margins--spacing-listlayout).


# Index
Expand All @@ -19,12 +19,12 @@ By default FlexScrollView uses the [ListLayout](../docs/layouts/ListLayout.md) l
- [Scrolling](#scrolling)
- [Margins & spacing](#margins--spacing-listlayout)
- [Direction & alignment](#direction--alignment)
- [Clipping & ContainerSurface's](#clipping--containersurfaces)
- [Clipping & ContainerSurfaces](#clipping--containersurfaces)
- [Pull to refresh](#pull-to-refresh)
- [Sticky headers](#sticky-headers-listlayout)
- [Advanced effects](#advanced-effects)
- [Embedded scrollview linking](#embedded-scrollview-linking)
- [Embedded scrollview scrolling restrictions](embedded-scrollview-scrolling-restrictions)
- [Embedded scrollview scrolling restrictions](#embedded-scrollview-scrolling-restrictions)

# Getting started

Expand Down Expand Up @@ -256,7 +256,7 @@ var scrollView = new FlexScrollView({
```


# Clipping & ContainerSurfaces's
# Clipping & ContainerSurfaces

When you need to clip the contents of the scrollview so it doesn't overflow, you typically have create a ContainerSurface and embed the scrollview inside it. The FlexScrollView can perform this task for you through the `useContainer` option. When `useContainer` is set to `true`, the scrollview is wrapped inside a ContainerSurface with `overflow: hidden`:

Expand Down

0 comments on commit ce9b68d

Please sign in to comment.