https://github.com/html-next/flexi-sustain
Extended Lifecycles and Recycling for Ember Components
https://github.com/html-next/flexi-sustain
flexi recyling
Last synced: 10 months ago
JSON representation
Extended Lifecycles and Recycling for Ember Components
- Host: GitHub
- URL: https://github.com/html-next/flexi-sustain
- Owner: html-next
- License: mit
- Created: 2016-12-26T22:19:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-12T22:42:22.000Z (over 7 years ago)
- Last Synced: 2025-08-16T23:46:55.742Z (10 months ago)
- Topics: flexi, recyling
- Language: JavaScript
- Homepage:
- Size: 560 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Flexi
[](http://badge.fury.io/js/flexi-sustain)
[](http://emberobserver.com/addons/flexi-sustain)
[](https://travis-ci.org/html-next/flexi-sustain)
[](https://codeclimate.com/github/html-next/flexi-sustain)
[](https://codeclimate.com/github/html-next/flexi-sustain/coverage)
[](https://david-dm.org/html-next/flexi-sustain)
[](https://david-dm.org/html-next/flexi-sustain#info=devDependencies)
[Changelog](./CHANGELOG.md)
## Installation
```cli
ember install flexi-sustain
```
## Support, Questions, Collaboration
Join the [Ember community on Discord](https://discord.gg/zT3asNS)
### Sustain
`Sustain` allows you to recycle a component instance across layout and route boundaries.
A sustain is essentially a "marker" for where a particular component instance is able to
be reused. It allows you to explicitly declare what features of your app can be "recycled".
Sustain improves the performance of your app by reducing the amount of work your app needs to do.
Instead of tearing down one instance and creating an entirely new instance, sustain seamlessly
swaps a component instance's location as layouts and routes transition from one position to the next.
```hbs
{{sustain model}}
```
Only one instance of the sustainable is alive and rendered at a time, but if you are animating
from one location to another you can choose to leave behind a copy.
```hbs
{{sustain model copy=true}}
```
By default, a sustain is destroyed when it has gone unused for one minute. You can alter this
expiration. A value of `0` will cause the sustain to live forever.
```hbs
{{sustain expires=}}
```
If you would like to use the same layout for multiple sustain instances, on the same page, you can specify
a `label`. This allows unique instances of the same layout, which update from route to route or layout to layout,
but do not overwrite previous sustains in the same template.
```hbs
{{sustain my-path label='foo'}}
{{sustain my-path label='bar'}}
```
## Contributing
- Open an Issue for discussion first if you're unsure a feature/fix is wanted.
- Branch off of `master` (default branch)
- Use descriptive branch names (e.g. `/`)
- Use [Angular Style Commits](https://github.com/angular/angular.js/blob/v1.4.8/CONTRIBUTING.md#commit)
- PR against `develop` (default branch).
### Commmits
Angular Style commit messages have the full form:
```cli
():
```
But the abbreviated form (below) is acceptable and often preferred.
```cli
():
```
Examples:
- chore(deps): bump deps in package.json and bower.json
- docs(component): document the `fast-action` component
## Thanks
A special thanks goes out to [@ebryn](https://github.com/ebryn) for the
inspiration to pursue a solution for explicit layouts, and [IsleofCode](https://isleofcode.com)
for providing the time to build it.