Supported Platforms

What You’ll Achieve

This page helps you answer one practical question quickly:

“Is my project platform compatible with AstroAnimate?”

By the end of this page, you will:

  • Know which platform compatibility is currently documented
  • Understand what is officially supported today
  • Avoid relying on unstated or assumed compatibility claims
  • Know how to validate your own environment safely

Prerequisites / Requirements

Before using this compatibility page:

  • You have reviewed /docs/installation/
  • You have reviewed /docs/quick-start/
  • You can confirm your Astro version in your project setup

Step-by-Step Guide

Step 1: Check official compatibility baseline

Current documented compatibility baseline:

  • Astro: ^4.0.0 | ^5.0.0

This is the explicit peer dependency range for AstroAnimate and should be treated as the primary support contract.

Step 2: Validate your environment

In your project, confirm:

  1. Your Astro version is within the supported range
  2. AstroAnimate is installed with the correct package name
  3. A basic component import renders successfully

Recommended first test:

  • Import FadeIn or Reveal into a test page
  • Run your project locally
  • Confirm expected behavior in your target browser environment

Step 3: Use compatibility labels in planning

Use the following interpretation:

  • ✅ Supported: Explicitly documented in package compatibility
  • ⚠️ Not yet documented: May work, but not declared as official support
  • ⚪ Needs verification: Environment-specific behavior that should be tested in your own stack

This approach keeps rollout decisions predictable and reduces production surprises.

Supported Platforms (Current)

Platform Area Status Notes
Astro Framework Supported `^4.0.0
Package import via npm Supported @astroanimate/core
Additional framework/platform matrices Needs verification To be documented as support policy expands

This applies a fade-in animation without adding runtime JavaScript.

FAQ (Developer Questions)

Is AstroAnimate only for Astro?
Yes. Treat compatibility outside the documented range as unverified until formally stated.
Which Astro versions are supported by AstroAnimate?
AstroAnimate currently supports Astro ^4.0.0 || ^5.0.0 || ^6.0.0.
Is compatibility guaranteed outside the documented Astro range?
No. Treat compatibility outside the documented range as unverified until formally stated.
Does this page include full browser-by-browser support today?
Not yet. At this stage, use your project-level testing matrix for browser/device validation.
How should teams use this page during rollout?
Use it as the official baseline for framework compatibility, then add project-specific validation for your target environments.
When should this page be expanded?
Expand it as support policy matures (for example, explicit browser matrices, runtime targets, and tested environment tables).