[Svelte] 액션

2020년 04월 03일8분 소요

이번 포스트에서는 Svelte의 액션(action)에 대해 이야기하도록 하겠습니다. Svelte의 액션은 Vue.js의 커스텀 디렉티브와 유사합니다. Svelte의 액션을 만드는 방법과 Vue.js의 커스텀 디렉티브를 만드는 방법을 비교하며 살펴보도록 하겠습니다.

디렉티브 만들기

Vue.js와 Svelte 각각 pannable이라는 디렉티브를 만들어 보도록 하겠습니다.

Vue.js 예제

Vue.js에서는 아래 코드와 같이 pannable 디렉티브를 만들 수 있습니다.

<!-- App.vue -->
<template>
  <div
    v-pannable
    @panstart="handlePanStart"
    @panmove="handlePanMove"
    @panend="handlePanEnd"
    class="box"
    :style="`transform: translate(${coords.x}px,${coords.y}px) rotate(${coords.x * 0.2}deg)`"
  ></div>
</template>
<script>
import Vue from 'vue'
import pannable from './pannable'

Vue.directive('pannable', pannable)

new Vue({
  el: '.box',
  data () {
    return {
      coords: {
        x: 0, y: 0
      }
    }
  },
  methods: {
    handlePanStart() {
    },
    handlePanMove(event) {
      this.coords.x += event.detail.dx
      this.coords.y += event.detail.dy
    },
    handlePanEnd(event) {
      this.coords.x = 0
      this.coords.y = 0
    }
  }
})
</script>

// pannable.js
export default {
  bind (node) {
    let x
    let y

    node.handleMousedown = function handleMousedown(event) {
      x = event.clientX;
      y = event.clientY;

      node.dispatchEvent(new CustomEvent('panstart', {
        detail: { x, y }
      }));

      window.addEventListener('mousemove', handleMousemove);
      window.addEventListener('mouseup', handleMouseup);
    }

    function handleMousemove(event) {
      const dx = event.clientX - x;
      const dy = event.clientY - y;
      x = event.clientX;
      y = event.clientY;

      node.dispatchEvent(new CustomEvent('panmove', {
        detail: { x, y, dx, dy }
      }));
    }

    function handleMouseup(event) {
      x = event.clientX;
      y = event.clientY;

      node.dispatchEvent(new CustomEvent('panend', {
        detail: { x, y }
      }));

      window.removeEventListener('mousemove', handleMousemove);
      window.removeEventListener('mouseup', handleMouseup);
    }

    node.addEventListener('mousedown', node.handleMousedown);

  },
  unbind (node) {
    node.removeEventListener('mousedown', node.handleMousedown);
  }
}

Vue.js의 pannable 디렉티브

위의 코드의 실행 결과는 CodePen에서 확인할 수 있습니다.

Vue.js에서 만든 커스텀 디렉티브는 v-디렉티브 이름 으로 사용할 수 있습니다. Vue.js의 커스텀 디렉티브는 bind, unbind 등의 몇 가지 라이프 사이클 함수를 속성으로 가지는 객체입니다. 커스텀 디렉티브를 사용하기 위해서는 Vue.directive를 사용하여 디렉티브를 정의해야 합니다.

handleMousedown는 이벤트 리스너를 해제해 줘야 하기 때문에 node.handleMousedown를 사용하여 bind, unbind 라이프 사이클 함수 간의 데이터를 공유했습니다.

Svelte 예제

Svelte에서는 아래 코드와 같이 pannable 액션을 만들 수 있습니다.

// pannable.js
export function pannable(node) {
  let x;
  let y;

  function handleMousedown(event) {
    x = event.clientX;
    y = event.clientY;

    node.dispatchEvent(new CustomEvent('panstart', {
      detail: { x, y }
    }));

    window.addEventListener('mousemove', handleMousemove);
    window.addEventListener('mouseup', handleMouseup);
  }

  function handleMousemove(event) {
    const dx = event.clientX - x;
    const dy = event.clientY - y;
    x = event.clientX;
    y = event.clientY;

    node.dispatchEvent(new CustomEvent('panmove', {
      detail: { x, y, dx, dy }
    }));
  }

  function handleMouseup(event) {
    x = event.clientX;
    y = event.clientY;

    node.dispatchEvent(new CustomEvent('panend', {
      detail: { x, y }
    }));

    window.removeEventListener('mousemove', handleMousemove);
    window.removeEventListener('mouseup', handleMouseup);
  }

  node.addEventListener('mousedown', handleMousedown);

  return {
    destroy() {
      node.removeEventListener('mousedown', handleMousedown);
    }
  };
}

<!-- App.svelte -->
<script>
  import { spring } from 'svelte/motion';
  import { pannable } from './pannable.js';

  const coords = { x: 0, y: 0 }

  function handlePanStart() {
  }

  function handlePanMove(event) {
    coords.x += event.detail.dx
    coords.y += event.detail.dy
  }

  function handlePanEnd(event) {
    coords.x = 0
    coords.y = 0
  }
</script>

<style>
  .box {
    --width: 100px;
    --height: 100px;
    position: absolute;
    width: var(--width);
    height: var(--height);
    left: calc(50% - var(--width) / 2);
    top: calc(50% - var(--height) / 2);
    border-radius: 4px;
    background-color: #ff3e00;
    cursor: move;
  }
</style>

<div class="box"
  use:pannable
  on:panstart={handlePanStart}
  on:panmove={handlePanMove}
  on:panend={handlePanEnd}
  style="transform:
    translate({coords.x}px,{coords.y}px)
    rotate({coords.x * 0.2}deg)"
></div>

Svelte의 pannable 디렉티브

Svelte에서 만든 액션은 use:액션 이름으로 액션을 사용할 수 있습니다. Svelte의 액션은 함수입니다. 리턴 값은 라이프 사이클 함수를 속성으로 가지는 객체입니다. 자세한 내용은 액션 함수에서 말씀드리도록 하겠습니다.

디렉티브 파라미터

Vue.js의 커스텀 디렉티브와 Svelte의 액션에 파라미터를 전달하는 방법을 살펴보겠습니다. Vue.js와 Svelte 각각 longpress라는 디렉티브를 만들어 보도록 하겠습니다.

Vue.js 예제

Vue.js에서는 아래 코드와 같이 longpress 디렉티브를 만들 수 있습니다.

<!-- App.vue -->
<template>
  <div id="app">
    <label>
      <input v-model="duration" type="range" max="2000" step="100">
      {{ duration }}ms
    </label>

    <button v-longpress="duration"
      @longpress="() => pressed = true"
      @mouseenter="() => pressed = false"
    >press and hold</button>

    <p v-if="pressed">congratulations, you pressed and held for {{ duration }}ms</p>
  </div>
</template>
<script>
  import Vue from 'vue'
  import longpress from './longpress'

  Vue.directive('longpress', longpress)

  new Vue({
    el: '#app',
    data () {
      return {
        pressed: false,
        duration: 2000
      }
    },
  })
</script>

// longpress.js
export default {
  bind (node, binding) {
    let timer
    let duration = binding.value

    node.handleMousedown = () => {
      timer = setTimeout(() => {
        node.dispatchEvent(
          new CustomEvent('longpress')
        );
      }, duration);
    };

    node.handleMouseup = () => {
      clearTimeout(timer)
    };

    node.addEventListener('mousedown', node.handleMousedown);
    node.addEventListener('mouseup', node.handleMouseup);
  },
  update (node, binding) {
    node.duration = binding.value
  },
  unbind (node) {
    node.removeEventListener('mousedown', node.handleMousedown);
    node.removeEventListener('mouseup', node.handleMouseup);
  }
}

Vue.js의 longpress 디렉티브

위의 코드의 실행 결과는 CodePen에서 확인할 수 있습니다.

v-longpress="duration"으로 전달된 duration 값은 디렉티브의 라이프 사이클 함수의 두 번째 인자인 binding.value를 통해 사용할 수 있습니다.

Vue.js 디렉티브는 객체 안에 있는 각각의 라이프 사이클 함수는 서로 다른 스코프를 가지고 있기 때문에 각각의 라이프 사이클 함수에서 정의한 변수는 공유되지 않습니다. duration, handleMousedown, handleMouseup는 값을 업데이트하기 위해, 이벤트 리스너를 해제하기 위해 라이프 사이클 함수 간에 공유가 되어야 합니다. node의 하위 속성으로 정의하여 공유하는 방법을 사용했습니다.

Svelte 예제

Svelte에서는 아래 코드와 같이 longpress 액션을 만들 수 있습니다.

<!-- App.svelte -->
<script>
  import { longpress } from './longpress.js';

  let pressed = false;
  let duration = 2000;
</script>

<label>
  <input type=range bind:value={duration} max={2000} step={100}>
  {duration}ms
</label>

<button use:longpress={duration}
  on:longpress="{() => pressed = true}"
  on:mouseenter="{() => pressed = false}"
>press and hold</button>

{#if pressed}
  <p>congratulations, you pressed and held for {duration}ms</p>
{/if}

// longpress.js
export function longpress(node, duration) {
  let timer;

  const handleMousedown = () => {
    timer = setTimeout(() => {
      node.dispatchEvent(
        new CustomEvent('longpress')
      );
    }, duration);
  };

  const handleMouseup = () => {
    clearTimeout(timer)
  };

  node.addEventListener('mousedown', handleMousedown);
  node.addEventListener('mouseup', handleMouseup);

  return {
    update(newDuration) {
      duration = newDuration;
    },
    destroy() {
      node.removeEventListener('mousedown', handleMousedown);
      node.removeEventListener('mouseup', handleMouseup);
    }
  };
}

Svelte의 longpress 디렉티브

use:longpress={duration}으로 전달된 duration 값은 액션 함수의 두 번째 인자로 전달되어 사용할 수 있습니다. 액션 함수의 update, destroy 라이프 사이클 함수를 사용했습니다.

Vue.js 디렉티브와 Svelte 액션 차이

아래 두 개의 코드를 보시면 둘의 차이를 쉽게 비교할 수 있습니다.

<template>
  <!-- 디렉티브 사용방법 -->
  <div v-directive="params">
</template>
<script>
  // ...
  // 디렉티브 생성방법
  Vue.directive('directive', {
    bind (el, binding, vnode) {
    },
    inserted (el, binding, vnode) {
    },
    update (el, binding, vnode) {
    },
    componentUpdated (el, binding, vnode) {
    },
    unbind (el, binding, vnode) {
    }
  })
  // ...
</script>

<script>
  // 액션 생성방법
  function action (node, params) {
    return {
      update () {
      },
      destroy () {
      }
    }
  }
</script>
<!-- 액션 사용방법 -->
<div use:action="params">

생성 및 사용 방법

Vue.js는 Vue.directive 함수에 디렉티브 이름과 정의한 디렉티브를 파라미터로 전달해야 합니다. v-디렉티브 이름="파라미터" 형태로 사용하면 됩니다. Svelte는 액션을 만들고 use:액션 이름={파라미터}형태로 사용하면 됩니다.

Object VS Function

Vue.js에서 디렉티브는 라이프 사이클 함수를 속성으로 가지는 객체입니다. Svelte에서 액션은 함수입니다. 파라미터로 HTML 요소와 액션 디렉티브에서 전달받은 파라미터를 가지고, 라이프 사이클 함수를 속성으로 가지는 객체를 리턴합니다. 자세한 내용은 액션 함수에서 말씀드리도록 하겠습니다.

라이프 사이클

Vue.js의 디렉티브는 bind, inserted, update, componentUpdated, unbind 5개의 라이프 사이클 함수를 가집니다. Svelte의 액션의 함수 본문에는 마운트 될 때의 동작을 정의하고, Vue.js보다 단순한 update, destroy 2개의 라이프 사이클 함수를 속성으로 가지는 객체를 리턴합니다. 자세한 내용은 액션 라이프 사이클에서 말씀드리도록 하겠습니다.

Action 함수

액션 함수의 형태는 아래와 같습니다.

action = (node: HTMLElement, parameters: any) => {
  update?: (parameters: any) => void,
  destroy?: () => void
}

파라미터

액션 함수는 2개의 파라미터를 가집니다.

node: 첫 번째 파라미터는 액션이 선언된 HTML 요소입니다.
parameters: 두 번째 파라미터는 use:액션 이름={parameters}로 전달되는 parameters입니다.

리턴 값

액션 함수는 update와 destroy 속성을 가지는 객체를 리턴해야 합니다. update와 destroy는 함수로 액션의 라이프 사이클 함수입니다.

라이프 사이클

액션의 라이프 사이클을 살펴보도록 하겠습니다.

function foo(node, bar) {
  // the node has been mounted in the DOM

  return {
    update(bar) {
      // the value of `bar` has changed
    },

    destroy() {
      // the node has been removed from the DOM
    }
  };
}

update: update 라이프 사이클 함수는 액션이 선언된 DOM이 마운트 된 후 액션의 파라미터가 변경될 때마다 호출됩니다.
destroy: destroy 라이프 사이클 함수는 액션이 선언된 DOM이 제거되기 직전에 호출됩니다. 할당받은 자원을 이 라이프 사이클 함수에서 해제해야 합니다.
mount: 액션이 선언된 DOM이 마운트 된 후 동작해야 할 코드가 있다면 함수의 본문에 선언하면 됩니다.

참고