client:load directive in Astro

Introduction

The client:load directive tells Astro to load and run a component only after the page has fully loaded in the browser. This helps keep the initial page fast and interactive.

When you want a component to appear only after the whole page is ready.

For interactive widgets that don't need to run during server rendering.

To improve page speed by delaying JavaScript until after load.

When you want to avoid blocking the initial page render with scripts.

Syntax

Astro

<ComponentName client:load />

Use it as an attribute on your Astro or framework component.

This directive delays loading the component's JavaScript until after the browser finishes loading the page.

Examples

This loads MyWidget only after the page load event.

Astro

<MyWidget client:load />

The Counter component will hydrate and run after the page is fully loaded.

Astro

<Counter client:load />

Sample Program

This Astro page imports a Counter component and uses client:load to load it only after the page finishes loading. The heading appears immediately, and the counter becomes interactive after load.

Astro

---
import Counter from '../components/Counter.jsx';
---
<html lang="en">
  <head>
    <title>Client Load Example</title>
  </head>
  <body>
    <h1>Welcome to Astro</h1>
    <Counter client:load />
  </body>
</html>

Important Notes

The client:load directive is great for non-critical interactive parts.

It waits for the full page load event, so it may delay interactivity slightly.

Use it to balance speed and interactivity in your Astro projects.

Summary

client:load delays component loading until after the page fully loads.

It helps keep initial page load fast and adds interactivity later.

Use it for widgets or components that don't need to run immediately.

Practice

1. What does the client:load directive do in Astro?

easy

A. It delays loading a component until the entire page has loaded.

B. It loads the component immediately during server rendering.

C. It prevents the component from ever loading on the client.

D. It loads the component only when it becomes visible on screen.

Solution

1. Step 1: Understand the purpose of client:load

   This directive delays the component's loading until after the full page load event.

2. Step 2: Compare with other loading strategies

   Unlike immediate or lazy loading on visibility, client:load waits for the whole page to finish loading.

3. Final Answer:

   It delays loading a component until the entire page has loaded. -> Option A

4. Quick Check:

   client:load delays loading = A [OK]

Hint: Remember: client:load waits for full page load before running [OK]

Common Mistakes:

• Confusing client:load with immediate loading
• Thinking it loads on scroll or visibility
• Assuming it prevents client loading entirely

2. Which is the correct self-closing syntax to use client:load on a component named MyWidget?

easy

A.

B.

C.

D.

Solution

1. Step 1: Recall Astro directive syntax

   Astro directives use colon syntax like client:load as an attribute on components.

2. Step 2: Check valid self-closing tag usage

   Using <MyWidget client:load /> is valid and concise for components without children.

3. Final Answer:

   <MyWidget client:load /> -> Option D

4. Quick Check:

   Correct directive syntax = A [OK]

Hint: Use colon syntax exactly: client:load [OK]

Common Mistakes:

• Replacing colon with camelCase or dash
• Omitting the colon
• Using incorrect closing tags

3. Given this Astro component usage:

<MyWidget client:load />

What will happen when the page loads?

medium

A. MyWidget renders immediately during server-side rendering.

B. MyWidget loads as soon as it scrolls into view.

C. MyWidget loads only after the entire page finishes loading in the browser.

D. MyWidget never loads on the client side.

Solution

1. Step 1: Understand client:load behavior

   The client:load directive delays loading the component until after the full page load event in the browser.

2. Step 2: Compare with other loading triggers

   It does not load immediately or on scroll, but waits for the page to fully load.

3. Final Answer:

   MyWidget loads only after the entire page finishes loading in the browser. -> Option C

4. Quick Check:

   client:load triggers after full page load = D [OK]

Hint: client:load waits for full page load before running component [OK]

Common Mistakes:

• Thinking it loads during server rendering
• Confusing with lazy loading on scroll
• Assuming it never loads on client

4. You wrote this code but the component loads immediately, not after page load:

<MyWidget client-load />

What is the error?

medium

A. You must import client:load from Astro first.

B. The directive should be client:load with a colon, not a dash.

C. The component must be wrapped in a <client:load> tag.

D. The component cannot be self-closing.

Solution

1. Step 1: Identify incorrect directive syntax

   The directive uses a dash client-load instead of the required colon client:load.

2. Step 2: Understand Astro directive rules

   Astro directives must use colon syntax exactly; dashes are invalid and ignored.

3. Final Answer:

   The directive should be client:load with a colon, not a dash. -> Option B

4. Quick Check:

   Correct directive syntax uses colon = C [OK]

Hint: Check for colon, not dash, in directive name [OK]

Common Mistakes:

• Using dash instead of colon in directive
• Thinking directives need imports
• Believing self-closing tags cause loading issues

5. You want to add a chat widget that should only load after the page fully loads to avoid slowing initial load. Which is the best way to do this in Astro?

hard

A. Use <ChatWidget client:load /> to delay loading until after page load.

B. Use <ChatWidget client:idle /> to load when browser is idle.

C. Use <ChatWidget client:visible /> to load when visible on screen.

D. Render <ChatWidget /> normally without directives.

Solution

1. Step 1: Identify the requirement

   The chat widget should load only after the full page load to keep initial load fast.

2. Step 2: Match directive to requirement

   client:load delays loading until after the page fully loads, fitting the need perfectly.

3. Step 3: Compare other options

   client:idle waits for browser idle, client:visible waits for scroll visibility, and no directive loads immediately.

4. Final Answer:

   Use <ChatWidget client:load /> to delay loading until after page load. -> Option A

5. Quick Check:

   Delay until full page load = client:load = B [OK]

Hint: Use client:load to delay widget until after full page load [OK]

Common Mistakes:

• Choosing client:idle or client:visible which load at different times
• Not using any directive causing immediate load
• Misunderstanding when client:load triggers