Action parameters in Svelte - Step-by-Step Execution

Concept Flow - Action parameters

Start: Element with action

↓

Action function called

↓

Receive parameters: node, parameters

↓

Use parameters inside action

↓

Return object with update and destroy

↓

If parameters change -> call update

↓

On element removal -> call destroy

↓

End

The action receives the element and parameters, uses them, and returns update and destroy functions to handle changes and cleanup.

Execution Sample

Svelte

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

This action sets background color on an element and updates or cleans it up when parameters change or element is removed.

Execution Table

Step	Action	Parameters Received	Effect on Element	Return Value
1	Action called on element	{ color: 'yellow' }	Sets backgroundColor to yellow	Returns update and destroy functions
2	Parameters update	{ color: 'lightblue' }	update() sets backgroundColor to lightblue	update function called
3	Element removed	N/A	destroy() clears backgroundColor	destroy function called
4	No more updates	N/A	No effect	Action lifecycle ends

💡 Element removed, destroy called, action lifecycle ends

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
node.style.backgroundColor	null	yellow	lightblue	null	null
parameters.color	undefined	yellow	lightblue	N/A	N/A

Key Moments - 3 Insights

Why does the action receive the element node and parameters?

The action needs the element to modify it and parameters to know how to modify it, as shown in step 1 of the execution_table.

What happens when parameters change after the action is applied?

The update function is called with new parameters to update the element, as shown in step 2 of the execution_table.

Why is the destroy function important?

Destroy cleans up changes when the element is removed, preventing leftover styles or effects, as shown in step 3.

Visual Quiz - 3 Questions

Look at the execution_table, what is the backgroundColor after step 2?

A yellow

B lightblue

C null

D unchanged

💡 Hint

Check the 'Effect on Element' column at step 2 in the execution_table.

At which step is the destroy function called?

A Step 3

B Step 2

C Step 1

D Step 4

💡 Hint

Look for 'destroy() clears backgroundColor' in the execution_table.

If the parameters never change, which function is never called?

A action function

B destroy

C update

D none

💡 Hint

See step 2 where update is called only when parameters change.

Concept Snapshot

Svelte actions receive the element node and parameters.
They modify the element using parameters.
Return update() to handle parameter changes.
Return destroy() to clean up on removal.
Update runs only if parameters change.
Destroy runs when element is removed.

Full Transcript

In Svelte, an action is a function that receives the HTML element and parameters. It can modify the element, for example by setting styles. The action returns an object with update and destroy functions. Update runs when parameters change to update the element accordingly. Destroy runs when the element is removed to clean up any changes. This lifecycle ensures the element stays in sync with parameters and cleans up properly.

Practice

1. What is the purpose of passing parameters to a Svelte action using use:action={parameter}?

easy

A. To define a new component inside the action

B. To customize the behavior of the action with extra data

C. To import external libraries into the action

D. To style the element directly from the action

Solution

1. Step 1: Understand action parameters

   Action parameters allow you to send extra data to a Svelte action to customize its behavior.

2. Step 2: Identify the purpose of use:action={parameter}

   This syntax passes the parameter to the action so it can use it internally.

3. Final Answer:

   To customize the behavior of the action with extra data -> Option B

4. Quick Check:

   Action parameters customize behavior = A [OK]

Hint: Parameters customize actions with extra data [OK]

Common Mistakes:

• Thinking parameters define components
• Confusing parameters with styling
• Assuming parameters import libraries

2. Which of the following is the correct syntax to pass a parameter named color with value 'red' to a Svelte action called highlight?

easy

A. use:highlight={{color: 'red'}}

B. use:highlight={'red'}

C. use:highlight={color} with let color = 'red'

D. use:highlight(color='red')

Solution

1. Step 1: Recall correct parameter passing syntax

   Svelte actions receive parameters using use:action={parameter} where parameter can be any value or object.

2. Step 2: Identify correct object syntax for passing color

   To pass an object with a key color and value 'red', use {color: 'red'} inside curly braces.

3. Final Answer:

   use:highlight={{color: 'red'}} -> Option A

4. Quick Check:

   Pass object with color key = D [OK]

Hint: Use curly braces with object for named parameters [OK]

Common Mistakes:

• Using parentheses instead of curly braces
• Passing string directly without braces
• Passing variable without defining it

3. Given this Svelte action:

function border(node, { color }) {
  node.style.border = `2px solid ${color}`;
  return {
    update({ color }) {
      node.style.border = `2px solid ${color}`;
    }
  };
}

What will be the border color after this code runs?

<div use:border={{ color: 'blue' }}>Box</div>

medium

A. A 2px solid blue border

B. No border will appear

C. A 2px solid red border

D. A 2px solid black border

Solution

1. Step 1: Understand initial border style setting

   The action sets the border style to '2px solid' plus the passed color, which is 'blue'.

2. Step 2: Confirm the border color after applying the action

   The div will have a blue border because the parameter color is 'blue' and the style is applied immediately.

3. Final Answer:

   A 2px solid blue border -> Option A

4. Quick Check:

   Passed color 'blue' sets border color = B [OK]

Hint: Action sets style using passed color parameter [OK]

Common Mistakes:

• Assuming default color instead of passed color
• Ignoring the update method
• Thinking no border is set initially

4. Consider this Svelte action code:

function scale(node, factor) {
  node.style.transform = `scale(${factor})`;
  return {
    update(newFactor) {
      node.style.transform = `scale(${newFactor})`;
    }
  };
}

Which of the following will result in an invalid CSS transform value when used as use:scale={...}?

medium

A. use:scale={2}

B. use:scale={'2'}

C. use:scale={{ factor: 2 }}

D. use:scale={0.5}

Solution

1. Step 1: Analyze expected parameter type

   The action expects a single number parameter factor, not an object.

2. Step 2: Identify which option passes an object instead of a number

   use:scale={{ factor: 2 }} passes an object { factor: 2 }, which will cause scale(${newFactor}) to become scale([object Object]), an invalid CSS transform value.

3. Final Answer:

   use:scale={{ factor: 2 }} -> Option C

4. Quick Check:

   Passing object instead of number causes invalid transform = C [OK]

Hint: Match parameter type expected by action exactly [OK]

Common Mistakes:

• Passing object when number expected
• Passing string instead of number (allowed but may cause visual issues)
• Passing objects when primitive expected

5. You want to create a Svelte action tooltip that shows a message passed as a parameter and updates the message if it changes. Which of these implementations correctly handles parameter updates?

hard

A. function tooltip(node, message) {
const tip = document.createElement('div');
tip.textContent = message;
node.appendChild(tip);
}

B. function tooltip(node, message) {
node.title = message;
return {};
}

C. function tooltip(node, message) {
node.setAttribute('tooltip', message);
}

D. function tooltip(node, message) {
const tip = document.createElement('span');
tip.textContent = message;
node.appendChild(tip);
return {
update(newMessage) {
tip.textContent = newMessage;
},
destroy() {
node.removeChild(tip);
}
};
}

Solution

1. Step 1: Check for update method handling parameter changes

   function tooltip(node, message) {
     const tip = document.createElement('span');
     tip.textContent = message;
     node.appendChild(tip);
     return {
       update(newMessage) {
         tip.textContent = newMessage;
       },
       destroy() {
         node.removeChild(tip);
       }
     };
   }

   defines an update method that updates the tooltip text when the parameter changes.

2. Step 2: Verify cleanup with destroy method

   This implementation also defines a destroy method to remove the tooltip element when the action is removed, which is good practice.

3. Final Answer:

   The implementation with update and destroy methods -> Option D

4. Quick Check:

   Update method handles parameter changes = A [OK]

Hint: Use update and destroy methods to handle changes and cleanup [OK]

Common Mistakes:

• Not implementing update method for parameter changes
• Not cleaning up DOM elements on destroy
• Using incorrect element types or missing return object