https://ko.react.dev/reference/react/useLayoutEffect

์ปดํฌ๋„ŒํŠธ๊ฐ€ ๋งˆ์šดํŠธ ๋˜๊ธฐ ์ „์— ์‹คํ–‰๋˜๋Š” ๋ฒ„์ „์˜ useEffect

useLayoutEffect๋Š” ๋ธŒ๋ผ์šฐ์ €๊ฐ€ ํ™”๋ฉด์„ ๋‹ค์‹œ ๊ทธ๋ฆฌ๋Š” ๊ฒƒ์„ ์ฐจ๋‹จํ•˜๊ธฐ์— ๊ณผ๋„ํ•˜๊ฒŒ ์‚ฌ์šฉํ•˜๋ฉด ์•ฑ์ด ๋А๋ ค์งˆ ์ˆ˜ ์žˆ๋‹ค. ๊ฐ€๊ธ‰์  useEffect๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹๋‹ค

๋™์ž‘ ๋ฐฉ์‹

  1. ์ปดํฌ๋„ŒํŠธ ๋ Œ๋”๋ง
  2. useLayoutEffect ์…‹์—… ์‹คํ–‰ โ†’ state ์—…๋ฐ์ดํŠธ ์ด‰๋ฐœ
  3. ์—…๋ฐ์ดํŠธ ๋œ state๋กœ ์ปดํฌ๋„ŒํŠธ ๋ฆฌ๋ Œ๋”๋ง
  4. 3์—์„œ ๋ Œ๋”๋ง๋œ ์ปดํฌ๋„ŒํŠธ๋ฅผ ํ™”๋ฉด์— ๋ฐ˜์˜ (์ด ๊ณผ์ •์—์„œ ์ข…์†์„ฑ๋ฐฐ์—ด ์„ค์ •์— ๋”ฐ๋ผ useLayoutEffect๋ฅผ ์žฌ์‹คํ–‰ํ•  ์ˆ˜ ์žˆ์Œ)

Usage

Measuring layout before the browser repaints the screen

ํˆดํŒ๊ณผ ๊ฐ™์€ ๊ฒฝ์šฐ ํ™”๋ฉด ์ƒ์˜ ์œ„์น˜์™€ ํฌ๊ธฐ์—๋”ฐ๋ผ ๋…ธ์ถœ๋˜๋Š” ์œ„์น˜๊ฐ€ ๋‹ค๋ฅผ ์ˆ˜ ์žˆ๋‹ค. ์ด์ฒ˜๋Ÿผ ์ตœ์ข…์ ์œผ๋กœ ๋ Œ๋”๋ง ๋  ์ปดํฌ๋„ŒํŠธ๊ฐ€ ๋ ˆ์ด์•„์›ƒ ์ •๋ณด๋ฅผ ์•Œ์•„์•ผํ•˜๊ณ , ์žฌ์กฐ์ •๋˜๋Š” ๊ณผ์ •์„ ์‚ฌ์šฉ์ž์—๊ฒŒ ๋…ธ์ถœ์‹œํ‚ค๊ณ  ์‹ถ์ง€ ์•Š์„๋•Œ useLayoutEffect๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.

function Tooltip() {  
	const ref = useRef(null);  
	const [tooltipHeight, setTooltipHeight] = useState(0); // You don't know real height yet  
	// ์•„์ง ์‹ค์ œ height ๊ฐ’์„ ๋ชจ๋ฆ…๋‹ˆ๋‹ค.  
	
	useLayoutEffect(() => {  
		const { height } = ref.current.getBoundingClientRect();  
		setTooltipHeight(height); // Re-render now that you know the real height  
		// ์‹ค์ œ ๋†’์ด๋ฅผ ์•Œ์•˜์œผ๋‹ˆ ์ด์ œ ๋ฆฌ๋ Œ๋”๋ง ํ•ฉ๋‹ˆ๋‹ค.  
	}, []);  
	
	// ...use tooltipHeight in the rendering logic below...  
	// ...์•„๋ž˜์— ์ž‘์„ฑ๋  ๋ Œ๋”๋ง ๋กœ์ง์— tooltipHeight๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค...  
}
  1. Tooltip์€ ์ดˆ๊ธฐ tooltipHeight = 0์œผ๋กœ ๋ Œ๋”๋ง๋œ๋‹ค (์ž„์˜๋กœ ์ง€์ •๋œ ๋†’์ด)
  2. React๋Š” ์ด๋ฅผ DOM์— ๋ฐฐ์น˜ํ•˜๊ณ  useLayoutEffect๋ฅผ ์‹คํ–‰ํ•œ๋‹ค.
  3. useLayoutEffect๋Š” ํˆดํŒ์˜ ๋†’์ด๋ฅผ ์ธก์ •ํ•˜๊ณ  ๋ฆฌ๋ Œ๋”๋ง์„ ์ด‰๋ฐœํ•œ๋‹ค.
  4. Tooltip์ด ์‹ค์ œ tooltipHeight์œผ๋กœ ๋ฆฌ๋ Œ๋”๋ง๋œ๋‹ค.
  5. React๊ฐ€ ์ด๋ฅผ DOM์— ๋ฐ˜์˜ํ•˜๋ฉด ๋ธŒ๋ผ์šฐ์ €์— ํˆดํŒ์ด ํ‘œ์‹œ๋œ๋‹ค.

์‹คํ—˜

  • useLayoutEffect์—์„œ ์˜์กดํ•˜๊ณ  ์žˆ๋Š” state๋ฅผ ์—…๋ฐ์ดํŠธํ•  ๊ฒฝ์šฐ, ํ™”๋ฉด์— ๋ฐ˜์˜์ด ๋๋‚˜๊ณ  ๋‹ค์‹œ useLayoutEffect๊ฐ€ ์‹คํ–‰๋œ๋‹ค. (ํ™”๋ฉด ๋ Œ๋”๋ง์„ ๋ง‰์ง€ ์•Š์Œ)
export default function App() {
	const [height, setHeight] = useState(0);
	
	useLayoutEffect(() => {
		setHeight(document.querySelector(".App").clientHeight);
		console.log(
			"Current rendered height is : " +
			document.querySelector(".height").innerHTML
		)
		console.log("Executed useLayoutEffect with : " + height);
	}, [height]);
	
	return (
	<div className="App">
		<h1>Hello CodeSandbox</h1>
		<h2>Start editing to see some magic happen!</h2>
		<span className="height">{height}</span>
	</div>
	);
}
Current rendered height is : 0
Executed useLayoutEffect with : 0
Current rendered height is : 128
Executed useLayoutEffect with : 128

์˜๋ฌธ

  • ํ™”๋ฉด์— ๋ฐ˜์˜๋˜๊ธฐ ์ „์ด๋ฉด useLayoutEffect์—์„œ document.querySelector ๋กœ ์ ‘๊ทผํ•ด์„œ ์–ป๋Š” ์ •๋ณด๋Š” ์—…๋ฐ์ดํŠธ ์ „ ์ •๋ณด์ธ๊ฐ€?
    • ์•„๋ž˜ ์‹คํ—˜์€ ๋™์ผํ•˜๊ฒŒ ๋‚˜์˜ด
    • ํ™”๋ฉด์— ๋ฐ˜์˜ํ•˜๊ธฐ ์ „์ด๋‹ˆ virtual dom ์—์„œ ๊ทธ๋ ค์ง„ ์ •๋ณด๋ฅผ ๊ฐ€์ ธ์˜ค๋Š”๊ฑด ๊ฐ€๋Šฅํ•˜๋˜ ํ˜„์žฌ ์‹ค์ œ DOM์˜ ๊ฐ’์„ ๊ฐ€์ ธ์˜ค๋ฉด ์ด์ „ ๊ฐ’์ด ๋ณด์—ฌ์ง€๋Š” ๊ฑธ ์ˆ˜๋„ ์žˆ์Œ
useLayoutEffect(() => {
	console.log(document.querySelector(".count").innerHTML);
	console.log(countRef.current.innerHTML);
}, [count]);
 
return (
	<button
		ref={countRef}
		onClick={() => setCount((prev) => prev + 1)}
		className="count">		
		{count} + 1
	</button>
);

review