Use XState Machines as components.
- XState >= 5
- TypeScript >= 5
- ember-source >= 5.1
- Glint >= 1.2.1
npm install ember-statechart-componentTo be able to use XState state.matches
method in our templates,
we will first need [email protected]+ or a HelperManager for
handling vanilla functions.
ember-functions-as-helper-polyfill
provides one:
npm install ember-functions-as-helper-polyfillIn app/app.js / app/app.ts, a one time setup function will need to be called so that the ComponentManager is registered.
import Application from '@ember/application';
import config from 'ember-app/config/environment';
import loadInitializers from 'ember-load-initializers';
import Resolver from 'ember-resolver';
import { setupComponentMachines } from 'ember-statechart-component';
export default class App extends Application {
modulePrefix = config.modulePrefix;
podModulePrefix = config.podModulePrefix;
Resolver = Resolver;
}
loadInitializers(App, config.modulePrefix);
setupComponentMachines();Example with Ember Octane
// app/components/toggle.js
import { createMachine } from 'xstate';
export default createMachine({
initial: 'inactive',
states: {
inactive: { on: { TOGGLE: 'active' } },
active: { on: { TOGGLE: 'inactive' } },
},
});Usage:
The default template for every createMachine(..) is
but that can be overriden to suit your needs by defining your own template.
The this is an instance of the XState Interpreter
// app/components/authenticated-toggle.js
import { getService } from 'ember-statechart-component';
import { createMachine } from 'xstate';
export default createMachine({
initial: 'inactive',
states: {
inactive: {
on: {
TOGGLE: [
{
target: 'active',
cond: 'isAuthenticated',
},
{ actions: ['notify'] },
],
},
},
active: { on: { TOGGLE: 'inactive' } },
},
}, {
actions: {
notify: (ctx) => {
getService(ctx, 'toasts').notify('You must be logged in');
},
},
guards: {
isAuthenticated: (ctx) => getService(ctx, 'session').isAuthenticated,
},
});Usage:
Having type checking with these state machines can be done automatically
after importing the /glint file in your types/<app-name>/glint-registry.d.ts.
import "@glint/environment-ember-loose";
import "@glint/environment-ember-loose/native-integration";
import "ember-page-title/glint";
// This import extends the type of `StateMachine` to be glint-compatible
import 'ember-statechart-component/glint';
declare module "@glint/environment-ember-loose/registry" {
export default interface Registry {
// How to define globals from external addons
}
}This argument allows you to pass a MachineOptions for actions, services, guards, etc.
Usage:
Toggle machine that needs a config
// app/components/toggle.js
import { createMachine, assign } from 'xstate';
export default createMachine({
initial: 'inactive',
states: {
inactive: { on: { TOGGLE: 'active' } },
active: {
on: {
TOGGLE: {
target: 'inactive',
actions: ['toggleIsOn']
}
}
},
},
});Sets the initial context. The current value of the context can then be accessed via state.context.
Usage:
Toggle machine that interacts with context
// app/components/toggle.js
import { createMachine, assign } from 'xstate';
export default createMachine({
initial: 'inactive',
states: {
inactive: {
on: {
TOGGLE: {
target: 'active',
actions: ['increaseCounter']
}
}
},
active: {
on: {
TOGGLE: {
target: 'inactive',
actions: ['increaseCounter']
}
}
},
},
}, {
actions: {
increaseCounter: assign({
counter: (context) => context.counter + 1
})
}
});The machine will use @state as the initial state.
Any changes to this argument
are not automatically propagated to the machine.
An ARGS_UPDATE event (see details below) is sent instead.
An event will be sent to the machine for you, ARGS_UPDATE, along
with all named arguments used to invoke the component.
- ember-source v3.28+
- typescript v4.5+
- ember-auto-import v2+
- A browser that supports Proxy
- Glint 0.8.3+
- Note that updates to glint support will not be covered by this library's adherance to SemVer. All glint-related updates will be bugfixes until Glint is declared stable.
See the Contributing guide for details.
This project is licensed under the MIT License.
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent