(Svelte) class properties 활용법

Nov 28, 2023

스벨트(Svelte)로 컴포넌트를 개발하면서,
HTML Element의 class 속성을 다른 컴포넌트로 전달해야 하는 상황이 종종 있습니다.
하지만 단순하게 접근하면 바로 문제가 발생합니다.

<script>
  export let class = "";
  // 🚨 Parsing error: 'class' is not allowed as a variable declaration name. eslint
  // 🚨 Variable declaration not allowed at this location. ts(1440)
</script>
svelte

에러가 발생되는 이유는 class는 클래스 객체를 생성하기 위한 javascript의 선언 명령어이기 때문입니다. 명령어를 변수로 활용할 수 없는 노릇이죠! 이는 React에서 class가 아닌 className을 사용하는 이유와 같습니다.

그렇다고 아래와 같이 className을 쓴다면, 통일성이 떨어지고 컴포넌트 사용 시 실수하기 쉬워집니다.

<script>
  export let className = '';
</script>

<Button className=""></Button>
<!-- 내가 만든 컴포넌트는 className 써야한다고..? -->
<button class=""></button>
svelte

이를 해결하기 위해 조금의 노하우가 필요한데요, 2가지 방법을 한번 살펴 보시죠.

방법 1: className

컴포넌트에서 classNameclass로 별칭을 지어 내보내면 됩니다.

<script>
  let className = '';
  export { className as class };
</script>

<div {...$$restProps} class={className}>...</div>
svelte

장점

  • 선언적인이다.
    • 직관적이고 변수를 재활용하기 좋다.

단점

  • 구문 형태가 조금 생소하다.
  • 코드가 길다. 세련되지 못하다.

오픈소스 예시

방법 2: $$props.class

svelte의 $$props는 컴포넌트에 전달된 모든 속성(props)을 포함하는 특별한 변수입니다.
이를 활용하여 간편하게 class 속성을 활용할 수 있습니다.

<div {...$$restProps} class={$$props.class}>...</div>
svelte

장점

  • 코드가 간결하다.

단점

  • $$restProps의 사용 위치에 제약이 있다.
  • <div class="btn {$$props.class}" {...$$restProps}>...</div>
    <!-- 🚨 `$$restProps`에 `class` 속성이 남아 있어 기존 내용를 덮어 씌우게 된다. -->
    svelte

오픈소스 예시

맺으면서

코딩은 언제나 그렇듯 정답은 없습니다.
개발 환경과 팀의 입맛에 맞게 사용 컨벤션을 정하면 될 것 같습니다. 위 예시를 svelte REPL에서 직접 사용해보고, 오픈소스 코드도 참고 해서 결정해보세요!