Ember CLI Svelte
Cybernetically-enhance your ambitious web apps
This experimental add-on makes it possible to use Svelte components within your Ember.js application.
Before this makes it to v1.0.0, there's a high likelihood you will run into problems. Please add a GitHub issue for any weirdness you run into.
Compatibility
- Ember.js v3.28 or above
- Ember CLI v3.28 or above
- Node.js v14 or above
There is no intention to support versions of Ember before v3.28.
Yeah but why?
Ember.js is a nice framework and Svelte is a great component compiler that is very straight-forward to use and portable. Oh, and I did it because I can.
Installation
ember install ember-cli-svelte
The svelte package will be added as a separate dependency in your project's package.json.
The default blueprint will automatically modify your app.js file to use the extended resolver from this add-on instead of the default one from ember-resolver.
In other words, the import of your app.js will go from looking like this:
import Resolver from 'ember-resolver';
to this:
import Resolver from 'ember-cli-svelte/resolver';
The extended resolver is necessary to support the resolution of .svelte files. In any case, you will need to use this resolver, so if you choose to use npm install instead of ember install, you must change this import by hand.
Usage
Simply drop a .svelte file in app/components, and then you can call it in your templates just like a regular Glimmer component.
<!-- app/components/hello.svelte -->
<script>
export let name;
</script>
<h2>Hello, {name}!</h2>
{{!-- app/templates/application.hbs --}}
<Hello @name="Tomster" />
Outputs:
<h2>Hello, Tomster!</h2>
Check out the dummy for more example usage.
Svelte Component Imports
Svelte components can import and use other Svelte components just like you would expect.
<!-- app/components/my-component.svelte -->
<script>
import SomeOtherComponent from './some-other-component.svelte';
</script>
<SomeOtherComponent />
The inclusion of the .svelte file extension is both technically necessary and helps support existing Svelte component code.
Svelte component code is added individually to the build tree with the .svelte.js suffix. Not only can they be imported in your Ember code just like any other module, but they are registered with the app and can be resolved that way.
Block Content
Svelte components can also take block content and use it in a default slot.
<!-- app/components/hello.svelte -->
<script>
export let name;
</script>
<h2>Hello, {name}!</h2>
<h3><slot></slot></h3>
{{!-- app/templates/application.hbs --}}
<Hello @name="Tomster">Meet Svelte</Hello>
Outputs:
<h2>Hello, Tomster!</h2>
<h3>Meet Svelte</h3>
Block content can be dynamic and the Svelte component can even dynamically show/hide the slot.
Reactivity
Keep in mind that Svelte's reactivity system is still separate from the Glimmer reactivity system and that certain things you can do in Glimmer won't work in Svelte.
For instance, in Ember/Glimmer, a template will automatically react to properties of an object like service:router because its properties are @tracked. Svelte has no awareness of @tracked, so it will not re-render in response to property value changes alone.
There is a couple of primary ways to work around this. The best one is to explicitly pass in reactive values as properties to a Svelte component.
<MySvelteComponent @routeName={{this.routerService.currentRouteName}} />
This approach effectively allows Glimmer to directly inform Svelte components on value changes that it's aware of. The reason it is ideal is because work only happens if something changes, making it the most efficient.
It might not always be practical to explicitly pass in reactive values as properties. A Svelte component may need to import and use something like a service on its own. In that case, Ember provides observers that can allow us to respond to changes.
<script>
import { onDestroy } from 'svelte';
import { addObserver, removeObserver } from '@ember/object/observers';
import { lookup } from 'ember-cli-svelte';
const [{ $$: self }] = arguments;
const routerService = lookup('service:router');
let routeName = routerService.currentRouteName;
addObserver(routerService, 'currentRouteName', self, () => {
routeName = routerService.currentRouteName;
}, true);
onDestroy(() => {
removeObserver(routerService, 'currentRouteName', self);
});
</script>
<p>{routeName}</p>
Lookups
Some convenience functions are provided for looking up and resolving objects from the Ember app.
<script>
import { lookup } from 'ember-cli-svelte';
const routerService = lookup('service:router');
</script>
Context
Within a Svelte component, you can access the Ember app owner object via the getContext API.
<!-- app/components/my-component.svelte -->
<script>
import { getContext } from 'svelte';
const owner = getContext('owner');
const router = owner.lookup('service:router');
function goToDetails() {
router.transitionTo('details');
}
</script>
<button on:click={goToDetails}>Show Details</button>
Any Svelte components that are invoked by another Svelte component will automatically inherit this context.
Route Templates
You can even use .svelte files for your route templates under app/templates. The model and the controller for the route are passed in as props.
<!-- app/templates/my-route.svelte -->
<script>
export let model, controller;
</script>
To render an outlet, use the Outlet component that comes with the add-on.
<!-- app/templates/application.svelte -->
<script>
import Outlet from 'ember-cli-svelte/components/outlet.svelte';
</script>
<Outlet />
Both the Glimmer {{outlet}} and Svelte <Outlet /> component behave in the same way and can render both Glimmer and Svelte templates.
Named outlets are not supported because they are no longer encouraged and will eventually be deprecated.
Ember Components
You can also invoke Ember/Glimmer components from within a Svelte component. This must be done by using the component function:
<script>
import { component } from 'ember-cli-svelte';
const MyComponent = component('my-component');
</script>
<MyComponent />
Notes
This add-on is not compatible with FastBoot. It remains to be seen whether it will ever be fully compatible with FastBoot. Typescript inside Svelte components also is not yet suppoorted.
Todo
- Preprocess Svelte JS code using host app's Babel transforms
- Support using Typescript
- Investigate FastBoot support (or at least not breaking)
- Embroider compatibility
Contributing
See the Contributing guide for details.
License
This project is licensed under the MIT License.
