Skip to content

Add optional elementRef prop to TransitionComponents #2093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 18, 2025
Merged

Add optional elementRef prop to TransitionComponents #2093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions src/components/transition/Slider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
import { useCallback, useEffect, useRef, useState } from 'preact/hooks';
import { useCallback, useEffect, useState } from 'preact/hooks';

import { useSyncedRef } from '../../hooks/use-synced-ref';
import type { TransitionComponent } from '../../types';
import { downcastRef } from '../../util/typing';

const Slider: TransitionComponent = ({
children,
direction = 'in',
onTransitionEnd,
delay,
elementRef,
}) => {
const visible = direction === 'in';
const containerRef = useRef<HTMLDivElement | null>(null);
const containerRef = useSyncedRef(elementRef);
const [containerHeight, setContainerHeight] = useState(visible ? 'auto' : 0);

// Whether the content is currently partially or wholly visible. This is
Expand Down Expand Up @@ -52,7 +55,7 @@ const Slider: TransitionComponent = ({

setContainerHeight(0);
}
}, [containerHeight, visible]);
}, [containerHeight, containerRef, visible]);

const handleTransitionEnd = useCallback(
(e: TransitionEvent) => {
Expand All @@ -72,7 +75,7 @@ const Slider: TransitionComponent = ({
}
onTransitionEnd?.(direction);
},
[setContainerHeight, visible, onTransitionEnd, direction],
[containerRef, visible, onTransitionEnd, direction],
);

const isFullyVisible = containerHeight === 'auto';
Expand All @@ -84,7 +87,7 @@ const Slider: TransitionComponent = ({
//
// @ts-ignore
ontransitionend={handleTransitionEnd}
ref={containerRef}
ref={downcastRef(containerRef)}
style={{
display: contentVisible ? '' : 'none',
height: containerHeight,
Expand Down
3 changes: 2 additions & 1 deletion src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,10 @@ export type IconComponent = FunctionComponent<JSX.SVGAttributes<SVGSVGElement>>;
export type TransitionComponent = FunctionComponent<{
/** Whether the children should be revealed ("in") or hidden ("out"). */
direction?: 'in' | 'out';

/** Callback invoked when transition ends. */
onTransitionEnd?: (direction: 'in' | 'out') => void;
/** Ref associated with component's outermost or primary element */
elementRef?: Ref<HTMLElement | undefined>;

/**
* Delay before transitions begin. This corresponds to the `transition-delay`
Expand Down