Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.4 KB

README.md

File metadata and controls

35 lines (23 loc) · 1.4 KB
Raw

Svelte Custom Element Transitions

It's a known issue that Svelte transitions do not work when compiling to custom elements (aka, web components). There's an active Pull Request which has been around for several months.

Hopefully that PR will be merged in the near future. But in case it doesn't, at least you have @auroratide/svelte-custom-element-transitions! This tiny module works around the issue by applying the CSS rules directly to the target node with Javascript.

<script>
  import { fade } from '@auroratide/svelte-custom-element-transitions'
</script>

<h1 transition:fade>Hello!</h1>

This module also provides a higher order function which can make custom transitions work as well.

import { forCustomElement } from '@auroratide/svelte-custom-element-transitions'

export const myTransition = forCustomElement((node, params) => {
    // ...
})

See the examples for different possible use cases.

By the way, each example is run as an automated test!

Contributing

This library is intended to become deprecated as soon as Svelte has an official solution. In the meantime, here are some helpful notes for anyone who wants to contribute:

  • npm run build: Build the library
  • npm test: Run verification script (in Chrome)
  • npm run example: See transitions in action