Context key patterns in Svelte

Introduction

Context key patterns help you share data between components without passing props all the time. It makes your code cleaner and easier to manage.

You want to share a theme or style settings across many components.

You need to pass user information from a top component to deep nested components.

You want to avoid passing the same data through many layers of components.

You want to share a function or state globally within a part of your app.

Syntax

Svelte

import { setContext, getContext } from 'svelte';

// In parent component
setContext(key, value);

// In child component
const value = getContext(key);

The key can be any value, but using a Symbol is best to avoid conflicts.

Only components inside the parent can access the context with the same key.

Examples

This example uses a simple string as the key to share a color value.

Svelte

// Using a string key
import { setContext, getContext } from 'svelte';

// Parent.svelte
setContext('color', 'blue');

// Child.svelte
const color = getContext('color');

Using a Symbol as the key helps avoid accidental key conflicts.

Svelte

// Using a Symbol key
import { setContext, getContext } from 'svelte';

const THEME = Symbol('theme');

// Parent.svelte
setContext(THEME, { background: 'white' });

// Child.svelte
const theme = getContext(THEME);

Sample Program

This example shows how to share user data using a Symbol key stored in a separate file. This avoids key mismatches and allows the child component to access the user info correctly.

Svelte

<!-- Parent.svelte -->
<script>
  import { setContext } from 'svelte';
  import Child from './Child.svelte';
  import { USER } from './userKey.js';
  const user = { name: 'Alice', loggedIn: true };
  setContext(USER, user);
</script>

<h1>Welcome to the app</h1>
<Child />

<!-- Child.svelte -->
<script>
  import { getContext } from 'svelte';
  import { USER } from './userKey.js';
  const user = getContext(USER);
</script>

<p>User name: {user.name}</p>
<p>Logged in: {user.loggedIn ? 'Yes' : 'No'}</p>

<!-- userKey.js -->
export const USER = Symbol('user');

Important Notes

Always use the same key instance (like a shared Symbol) in both setContext and getContext.

Context only works downward in the component tree, not upward or sideways.

Context is great for global-like data but avoid overusing it for everything.

Summary

Context key patterns let you share data easily between components without props.

Use Symbols as keys to avoid conflicts and keep keys unique.

Keep your keys in shared files to use them consistently across components.

Practice

1. What is the main reason to use Symbol as a context key in Svelte?

easy

A. To ensure the key is unique and avoid conflicts between components

B. To make the key a string for easier debugging

C. To allow the key to be reused as a CSS class name

D. To automatically serialize the key for storage

Solution

1. Step 1: Understand context keys purpose

   Context keys identify data shared between components without props.

2. Step 2: Why use Symbol?

   Symbols are unique values, preventing accidental key collisions.

3. Final Answer:

   To ensure the key is unique and avoid conflicts between components -> Option A

4. Quick Check:

   Unique keys = Symbol usage [OK]

Hint: Symbols guarantee unique keys, preventing conflicts [OK]

Common Mistakes:

• Using strings that can clash with other keys
• Thinking keys must be strings for context
• Reusing keys across unrelated components

2. Which of the following is the correct way to create and export a context key in Svelte?

easy

A. export let key = new Symbol('myKey');

B. export const key = 'myKey';

C. const key = Symbol('myKey'); export default key;

D. export const key = Symbol('myKey');

Solution

1. Step 1: Check correct Symbol creation

   Symbols are created with Symbol('description'), not with new.

2. Step 2: Check export syntax

   Exporting a constant with export const key = Symbol('myKey'); is correct and common.

3. Final Answer:

   export const key = Symbol('myKey'); -> Option D

4. Quick Check:

   Correct Symbol export = export const key = Symbol('myKey'); [OK]

Hint: Use export const with Symbol() without new keyword [OK]

Common Mistakes:

• Using string instead of Symbol for key
• Using new Symbol() which is invalid
• Exporting default instead of named export

3. Given this code snippet, what will be logged in the Child.svelte component?

/* key.js */
export const userKey = Symbol('user');

/* Parent.svelte */
import { setContext } from 'svelte';
import { userKey } from './key.js';

setContext(userKey, { name: 'Alice' });

/* Child.svelte */
import { getContext } from 'svelte';
import { userKey } from './key.js';

const user = getContext(userKey);
console.log(user.name);

medium

A. Alice

B. undefined

C. Error: userKey is not defined

D. null

Solution

1. Step 1: Understand setContext and getContext usage

   Parent sets context with key userKey and value { name: 'Alice' }.

2. Step 2: Child retrieves context using same key

   Child imports userKey and calls getContext(userKey), getting the object.

3. Final Answer:

   Alice -> Option A

4. Quick Check:

   Matching keys return value = Alice [OK]

Hint: Matching Symbol keys share data correctly [OK]

Common Mistakes:

• Using different keys causing undefined
• Forgetting to import the shared key
• Expecting string keys instead of Symbol keys

4. Identify the error in this Svelte code using context keys:

/* key.js */
export const themeKey = Symbol('theme');

/* Parent.svelte */
import { setContext } from 'svelte';
import { themeKey } from './key.js';

setContext('themeKey', 'dark');

/* Child.svelte */
import { getContext } from 'svelte';
import { themeKey } from './key.js';

const theme = getContext(themeKey);
console.log(theme);

medium

A. Forgetting to import setContext in Parent

B. Using string 'themeKey' instead of Symbol key in setContext

C. Using getContext before setContext is called

D. Not exporting themeKey from key.js

Solution

1. Step 1: Check setContext key usage

   Parent uses string 'themeKey' instead of the Symbol themeKey imported from key.js.

2. Step 2: Understand key mismatch effect

   Child uses Symbol key, so getContext returns undefined because keys differ.

3. Final Answer:

   Using string 'themeKey' instead of Symbol key in setContext -> Option B

4. Quick Check:

   Key mismatch causes undefined context [OK]

Hint: Always use the same Symbol key in setContext and getContext [OK]

Common Mistakes:

• Mixing string and Symbol keys
• Assuming string keys work like Symbols
• Not importing the shared key properly

5. You want to share a theme object between multiple nested components using context keys. Which pattern is best to avoid key conflicts and ensure consistent usage?

hard

A. Create a new Symbol key in each component separately

B. Use a plain string key like 'theme' directly in setContext and getContext calls

C. Define and export a unique Symbol key in a separate file, then import it in all components

D. Use a global variable without context to share the theme

Solution

1. Step 1: Understand key uniqueness and sharing

   Using a shared Symbol key exported from one file ensures all components use the exact same key.

2. Step 2: Avoid conflicts and inconsistencies

   Using strings or separate Symbols risks conflicts or mismatches causing bugs.

3. Final Answer:

   Define and export a unique Symbol key in a separate file, then import it in all components -> Option C

4. Quick Check:

   Shared Symbol key file = consistent context [OK]

Hint: Keep keys in one file, import everywhere to avoid conflicts [OK]

Common Mistakes:

• Using different keys in different components
• Relying on strings that may clash
• Avoiding context and using globals instead