Why actions add reusable element behavior in Svelte

Introduction

Actions let you add extra behavior to HTML elements that you can use again and again. They keep your code clean and easy to manage.

When you want to add the same interactive feature to many buttons or inputs.

When you need to handle events or animations on elements without repeating code.

When you want to keep your component code simple by moving element-specific logic outside.

When you want to share element behavior across different components.

When you want to clean up event listeners or effects automatically when elements are removed.

Syntax

Svelte

function myAction(node, parameters) {
  // setup code here
  return {
    update(newParameters) {
      // handle parameter changes
    },
    destroy() {
      // cleanup code here
    }
  };
}

The node is the HTML element the action is applied to.

The function can return an object with update and destroy to handle changes and cleanup.

Examples

This action focuses the element when it is created.

Svelte

function focus(node) {
  node.focus();
}

This action changes the background color and updates it if the color changes.

Svelte

function highlight(node, color) {
  node.style.backgroundColor = color;
  return {
    update(newColor) {
      node.style.backgroundColor = newColor;
    },
    destroy() {
      node.style.backgroundColor = '';
    }
  };
}

Sample Program

This example shows a tooltip action that adds a small popup text when you hover over the button. The action handles showing and hiding the tooltip and cleans up event listeners when the button is removed.

Svelte

<script>
  function tooltip(node, text) {
    let tooltipDiv;
    function mouseOver() {
      tooltipDiv = document.createElement('div');
      tooltipDiv.textContent = text;
      tooltipDiv.style.position = 'absolute';
      tooltipDiv.style.background = 'black';
      tooltipDiv.style.color = 'white';
      tooltipDiv.style.padding = '0.25rem 0.5rem';
      tooltipDiv.style.borderRadius = '0.25rem';
      tooltipDiv.style.top = `${node.getBoundingClientRect().bottom + 5}px`;
      tooltipDiv.style.left = `${node.getBoundingClientRect().left}px`;
      document.body.appendChild(tooltipDiv);
    }
    function mouseOut() {
      if (tooltipDiv) {
        tooltipDiv.remove();
        tooltipDiv = null;
      }
    }
    node.addEventListener('mouseover', mouseOver);
    node.addEventListener('mouseout', mouseOut);
    return {
      update(newText) {
        text = newText;
      },
      destroy() {
        node.removeEventListener('mouseover', mouseOver);
        node.removeEventListener('mouseout', mouseOut);
        if (tooltipDiv) tooltipDiv.remove();
      }
    };
  }
</script>

<button use:tooltip="Click me!">Hover me</button>

Important Notes

Actions help keep your components simple by moving element-specific code outside.

Always clean up event listeners or timers in the destroy method to avoid memory leaks.

You can pass parameters to actions and update them dynamically.

Summary

Actions add reusable behavior directly to HTML elements.

They help share and organize code for element interactions.

Actions can set up, update, and clean up behavior easily.

Practice

1. What is the main purpose of actions in Svelte?

easy

A. To create new components

B. To style elements with CSS

C. To manage global state

D. To add reusable behavior directly to HTML elements

Solution

1. Step 1: Understand what actions do

   Actions in Svelte attach behavior to elements, like event listeners or animations.

2. Step 2: Compare with other options

   Creating components, managing state, or styling are done differently, not by actions.

3. Final Answer:

   To add reusable behavior directly to HTML elements -> Option D

4. Quick Check:

   Actions = reusable element behavior [OK]

Hint: Actions add behavior to elements, not components or styles [OK]

Common Mistakes:

• Confusing actions with components
• Thinking actions manage app state
• Assuming actions handle styling

2. Which is the correct syntax to use an action named tooltip on a button element in Svelte?

easy

A. Click me

B. Click me

C. Click me

D. Click me

Solution

1. Step 1: Recall Svelte action syntax

   Actions are applied with use:actionName on elements.

2. Step 2: Check each option

   Only use:tooltip matches the correct syntax; others are for events or bindings.

3. Final Answer:

   <button use:tooltip>Click me</button> -> Option A

4. Quick Check:

   Action syntax = use:actionName [OK]

Hint: Use 'use:' prefix to apply actions on elements [OK]

Common Mistakes:

• Using 'action=' instead of 'use:'
• Confusing actions with event handlers
• Trying to bind actions like variables

3. Given this Svelte action code:

function highlight(node) {
  node.style.backgroundColor = 'yellow';
  return {
    destroy() {
      node.style.backgroundColor = '';
    }
  };
}

What happens when this action is used on an element?

medium

A. The element's background turns yellow and stays yellow forever

B. The element's background turns yellow and resets when removed

C. The element's background color is set to empty string immediately

D. The element's background color changes only on hover

Solution

1. Step 1: Analyze the action behavior

   The action sets background to yellow on start, and resets it on destroy.

2. Step 2: Understand lifecycle

   Destroy runs when element is removed or action is cleaned up, resetting style.

3. Final Answer:

   The element's background turns yellow and resets when removed -> Option B

4. Quick Check:

   Action sets and cleans up style [OK]

Hint: Destroy method cleans up changes when element is removed [OK]

Common Mistakes:

• Thinking style never resets
• Assuming style changes only on hover
• Ignoring the destroy cleanup

4. Identify the issue in this Svelte action usage:

function focus(node) {
  node.focus();
}

<input use:focus />

medium

A. The action function must be async

B. The action should be called inside onMount lifecycle

C. The action should return an object with a destroy method

D. The action must be assigned to a variable before use

Solution

1. Step 1: Check action return value

   Actions should return an object with a destroy method to clean up; here it returns nothing.

2. Step 2: Understand optional return

   Returning nothing is allowed if no cleanup needed, but best practice is to return an object.

3. Final Answer:

   The action should return an object with a destroy method -> Option C

4. Quick Check:

   Actions should return cleanup object [OK]

Hint: Always return cleanup object from actions if needed [OK]

Common Mistakes:

• Thinking actions must be async
• Believing actions need lifecycle hooks
• Assuming actions must be variables

5. You want to create a reusable Svelte action that adds a tooltip to any element. Which approach best uses actions to achieve this?

hard

A. Create an action that adds event listeners to show/hide tooltip and cleans up on destroy

B. Create a component wrapping the element and tooltip inside

C. Use CSS :hover to show tooltip without JavaScript

D. Add tooltip text directly inside the element's innerHTML

Solution

1. Step 1: Understand reusable behavior with actions

   Actions attach behavior directly to elements and can manage events and cleanup.

2. Step 2: Compare options for tooltip

   Only an action adding event listeners and cleanup fits reusable behavior on any element.

3. Final Answer:

   Create an action that adds event listeners to show/hide tooltip and cleans up on destroy -> Option A

4. Quick Check:

   Actions manage reusable element behavior best [OK]

Hint: Use actions for reusable element event behavior and cleanup [OK]

Common Mistakes:

• Using components instead of actions for element behavior
• Relying only on CSS without JS for dynamic tooltips
• Modifying innerHTML directly causing side effects