flexi-sustain
v1.2.0
Published
The sustain portion of flexi
Downloads
14
Readme
Flexi
Installation
ember install flexi-sustainThat's all that required if you're using the classic component layout. If you are using a pod-based structure you will also need to install the shim for ember-app. This is done by modifiying your ember-cli-build.js file. This shim makes ember-cli's template tree able to find
the templates for layouts.
var EmberApp = require('ember-cli/lib/broccoli/ember-app');
var shim = require('flexi/lib/pod-templates-shim');
shim(EmberApp);Support, Questions, Collaboration
Join the flexi channel on Slack.
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.
{{sustain <path-to-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.
{{sustain <path-to-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.
{{sustain <path-to-sustain> expires=<time-in-ms>}}Contributing
- Open an Issue for discussion first if you're unsure a feature/fix is wanted.
- Branch off of
develop(default branch) - Use descriptive branch names (e.g.
<type>/<short-description>) - Use Angular Style Commits
- PR against
develop(default branch).
Commmits
Angular Style commit messages have the full form:
<type>(<scope>): <title>
<body>
<footer>But the abbreviated form (below) is acceptable and often preferred.
<type>(<scope>): <title>Examples:
- chore(deps): bump deps in package.json and bower.json
- docs(component): document the
fast-actioncomponent
Thanks
A special thanks goes out to @ebryn for the inspiration to pursue a solution for explicit layouts, and IsleofCode for providing the time to build it.