---
url: /reference/items/Transition.md
---
# Transition
The Transition primitive should be used when creating components which can switch between two states (often visible/hidden). It implements the [`transition` utility](https://js-toolkit.studiometa.dev/utils/css/transition.html) from the [@studiometa/js-toolkit package](https://js-toolkit.studiometa.dev) and provides configuration via `data-option-...` attributes and actions with the `enter`, `leave` and `toggle` methods which trigger the transition between the two states of the component.
It is available as a `Transition` component as well as a `withTransition(Base)` decorator.
## Usage
As a primitive, the `Transition` class should be used to create other components instead of being used directly in an application.
```js
import { Transition } from '@studiometa/ui';
export default class Togglable extends Transition {
static config = {
name: 'Togglable',
};
}
```
Once you component is created, you can use it in your app and trigger its `enter` and `leave` methods to switch its states:
```js {2,10,13-15,17-19}
import { Base, createApp } from '@studiometa/js-toolkit';
import Togglable from './Togglable.js';
class App extends Base {
static config = {
name: 'App',
refs: ['enterBtn', 'leaveBtn'],
components: {
Togglable,
},
};
onEnterBtnClick() {
this.$children.Togglable[0].enter();
}
onLeaveBtnClick() {
this.$children.Togglable[0].leave();
}
}
export default createApp(App);
```
You can now add a togglable component in your HTML with the needed option to describe the transition:
```html
...
```
::: tip Example
Checkout the [result of this example](./examples#togglable) for a better understanding.
:::
### Use the decorator to make an existing component transitionable
The transition API can be added to an existing component by wrapping it with the `withTransition` decorator. The `Togglable` component from the previous example can also be implemented as follows:
```js {2,4}
import { Base } from '@studiometa/js-toolkit';
import { withTransition } from '@studiometa/ui';
export default class Togglable extends withTransition(Base) {
// ...
}
```