Skip to content

Commit 9383ee3

Browse files
committed
Rename the Transition events to match the Svelte names
See #57
1 parent 27df81d commit 9383ee3

File tree

6 files changed

+44
-42
lines changed

6 files changed

+44
-42
lines changed

src/lib/components/transitions/TransitionChild.svelte

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,17 @@
7676
7777
/***** Events *****/
7878
const dispatch = createEventDispatcher<{
79-
afterEnter: null;
80-
afterLeave: null;
81-
beforeEnter: null;
82-
beforeLeave: null;
79+
introstart: null;
80+
introend: null;
81+
outrostart: null;
82+
outroend: null;
8383
}>();
8484
8585
const forwardEvents = forwardEventsBuilder(get_current_component(), [
86-
"beforeEnter",
87-
"beforeLeave",
88-
"afterEnter",
89-
"afterLeave",
86+
"introstart",
87+
"introend",
88+
"outrostart",
89+
"outroend",
9090
]);
9191
9292
/***** Component *****/
@@ -112,7 +112,7 @@
112112
if (!isTransitioning) {
113113
state = TreeStates.Hidden;
114114
$nestingContext.unregister(id);
115-
dispatch("afterLeave");
115+
dispatch("outroend");
116116
}
117117
})
118118
);
@@ -167,8 +167,8 @@
167167
168168
isTransitioning = true;
169169
170-
if (show) dispatch("beforeEnter");
171-
if (!show) dispatch("beforeLeave");
170+
if (show) dispatch("introstart");
171+
if (!show) dispatch("outrostart");
172172
173173
return show
174174
? transition(
@@ -179,7 +179,7 @@
179179
enteredClasses,
180180
(reason) => {
181181
isTransitioning = false;
182-
if (reason === Reason.Finished) dispatch("afterEnter");
182+
if (reason === Reason.Finished) dispatch("introend");
183183
}
184184
)
185185
: transition(
@@ -198,7 +198,7 @@
198198
if (!hasChildren($nesting)) {
199199
state = TreeStates.Hidden;
200200
$nestingContext.unregister(id);
201-
dispatch("afterLeave");
201+
dispatch("outroend");
202202
}
203203
}
204204
);

src/lib/components/transitions/TransitionChildWrapper.svelte

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
import type { HTMLActionArray } from "$lib/hooks/use-actions";
1111
import { hasTransitionContext } from "./common.svelte";
1212
const forwardEvents = forwardEventsBuilder(get_current_component(), [
13-
"beforeEnter",
14-
"beforeLeave",
15-
"afterEnter",
16-
"afterLeave",
13+
"introstart",
14+
"introend",
15+
"outrostart",
16+
"outroend",
1717
]);
1818
1919
/***** Props *****/
@@ -35,10 +35,10 @@
3535
{...$$props}
3636
{as}
3737
use={[...use, forwardEvents]}
38-
on:afterEnter
39-
on:afterLeave
40-
on:beforeEnter
41-
on:beforeLeave
38+
on:introstart
39+
on:introend
40+
on:outrostart
41+
on:outroend
4242
>
4343
<slot />
4444
</TransitionRoot>
@@ -47,10 +47,10 @@
4747
{...$$props}
4848
{as}
4949
use={[...use, forwardEvents]}
50-
on:afterEnter
51-
on:afterLeave
52-
on:beforeEnter
53-
on:beforeLeave
50+
on:introstart
51+
on:introend
52+
on:outrostart
53+
on:outroend
5454
>
5555
<slot />
5656
</TransitionChild>

src/lib/components/transitions/TransitionRoot.svelte

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@
3333
} from "./common.svelte";
3434
import type { TRestProps } from "$lib/types";
3535
const forwardEvents = forwardEventsBuilder(get_current_component(), [
36-
"beforeEnter",
37-
"beforeLeave",
38-
"afterEnter",
39-
"afterLeave",
36+
"introstart",
37+
"introend",
38+
"outrostart",
39+
"outroend",
4040
]);
4141
4242
/***** Props *****/
@@ -121,10 +121,10 @@
121121
{...$$restProps}
122122
{as}
123123
use={[...use, forwardEvents]}
124-
on:afterEnter
125-
on:afterLeave
126-
on:beforeEnter
127-
on:beforeLeave
124+
on:introstart
125+
on:introend
126+
on:outrostart
127+
on:outroend
128128
>
129129
<slot />
130130
</TransitionChild>

src/routes/dialog/index.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
{#if nested}
5656
<Nested on:close={() => (nested = false)} />
5757
{/if}
58-
<Transition show={isOpen} on:afterLeave={() => console.log("done")}>
58+
<Transition show={isOpen} on:outroend={() => console.log("done")}>
5959
<Dialog on:close={() => (isOpen = false)}>
6060
<div class="fixed z-10 inset-0 overflow-y-auto">
6161
<div

src/routes/docs/latest/transition.svx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -215,10 +215,12 @@ This component also dispatches the following custom events, which are listened t
215215

216216
| Event name | Type of event `.detail` | Description |
217217
| ------------- | ----------------------- | ----------------------------------------------- |
218-
| `beforeEnter` | `null` | Dispatched before we start the enter transition |
219-
| `afterEnter` | `null` | Dispatched after we finish the enter transition |
220-
| `beforeLeave` | `null` | Dispatched before we start the leave transition |
221-
| `afterLeave` | `null` | Dispatched after we finish the leave transition |
218+
| `introstart` | `null` | Dispatched before we start the enter transition |
219+
| `introend` | `null` | Dispatched after we finish the enter transition |
220+
| `outrostart` | `null` | Dispatched before we start the leave transition |
221+
| `outroend` | `null` | Dispatched after we finish the leave transition |
222+
223+
These event names have been changed to match the names that Svelte uses for transitions, starting in version 2.0 of this library.
222224

223225
### TransitionChild
224226

src/routes/transitions/component-examples/modal.svelte

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@
4242
<Transition
4343
show={isOpen}
4444
class="fixed inset-0 z-10 overflow-y-auto"
45-
on:beforeEnter={() => {
45+
on:introstart={() => {
4646
addEvent("Before enter");
4747
}}
48-
on:afterEnter={() => {
48+
on:introend={() => {
4949
inputRef?.focus();
5050
addEvent("After enter");
5151
}}
52-
on:beforeLeave={() => {
52+
on:outrostart={() => {
5353
addEvent("Before leave (before confirm)");
5454
window.confirm("Are you sure?");
5555
addEvent("Before leave (after confirm)");
5656
}}
57-
on:afterLeave={(event) => {
57+
on:outroend={(event) => {
5858
addEvent(`After leave (before alert)`);
5959
window.alert("Consider it done!");
6060
addEvent(`After leave (after alert)`);

0 commit comments

Comments
 (0)