Releases: alexlafroscia/ember-steps
v6.0.1
v6.0.0
6.0.0 (2018-06-17)
Bug Fixes
- ensure
isActive
re-computes correctly (e3e29d3)
Features
- expose array of step objects (ce6ffa9)
- expose step info in array (6dd485e)
- step context (f9bfdd0), closes #104
- support transitioning to a StepNode (7253914)
BREAKING CHANGES
- The exposed type of the
steps
array has changed, requiring a user to
reach into that object to extract the name if they need to.
Alternatively, they could use something likeember-composable-helpers
to get an array ofStepName
from the array ofStepNode
v5.0.2
v5.0.1
v5.0.0-beta.2
v5.0.0-beta.1
Back to Basics
Docs: http://alexlafroscia.com/ember-steps/v4.0.0/docs
Breaking Changes
step-manager
is no longer cyclical by default
Originally, the underlying state machine in the step-manger
was cyclical, meaning that the first step pointed "backwards" to the last step, and the last step pointed "forward" to the first step. This doesn't really make a lot of sense, though.
Instead, by default, the state machine is now linear, meaning that the first step has no "previous" and the last step has no "next". Whether or not there is a next or previous step is now provided by both the step-manager
and each step
. See this page in the documentation for details.
If you want to retain the cyclical nature of the state machine, you can pass linear=false
to the step-manager
component and it will function the same way as it used to.
Removal of did-transition
and will-transition
hooks from the step-manager
This code got pretty gnarly, and it became clear to me that it doesn't makes sense for the step-manager
to know anything about validating that the transition should take place. Rather than trying to transition and failing, we should just avoid executing the transition if that's the desired behavior. This also allows the step-manager
to be entirely synchronous.
However, since validating transitions is still something that we want to allow for, the addon ships with a validate-transition
helper that you can compose a validator action into, allowing you to execute a transition conditionally. Check out this page in the documentation for an example of how to use validate-transition
.
Removal of did-enter
and will-enter
from step
Much like the {did|will}-transition
hooks on the manager, these are concerns outside of the step-manager
. If you want to respond to a transition taking place, see this example in the documentation for a tip on how you can compose actions together to the same effect. If you feel like that doesn't handle your use-case, please open an issue.
Removal of custom error classes
Originally this addon threw some custom error classes based on what went wrong. This has been replaced by "regular" Ember.assert
usage. You should remove any logic that might have interacted with those specific error classes.
New Features
Linear state machine
The step-manager
now creates a linear sequence of steps by default, which is more likely to be what you want anyway.
Surfacing whether a step has a "next" or "previous"
Now that a step can not have a "next" or "previous", the step-manager
surfaces whether the current step has a next/previous step.
Each step also surfaces this information about itself
Improvements
- No longer tries to determine the initial step at build time
- Removes the need for the
htmlbars
transform; everything can be done at runtime
- Removes the need for the
- Simplified API, making maintenance easier
- Better documentation, with thorough examples
v3.0.0
Docs: http://alexlafroscia.com/ember-steps/v3.0.0/docs
Breaking Changes
- Upgrade addon to use Ember module import APIs
- Bump minimum version to
2.12
Features
- Way better documentation, built with
ember-cli-addon-docs
v2.3.1
Bug Fixes
- Avoid calling
.set
on a destroyed object - #83 (@Bartheleway)
v2.3.0
New Features
- #79 Possibility to have an asynchronous process in "will-transition" action (@Bartheleway)