Skip to content

Retro Grid

An animated scrolling retro grid effect

Retro Grid
View source on GitHub

Installation

Copy the component files below into src/components/spark-ui/retro-grid/. Utility imports use @/lib/utils.

retro-grid.vue
vue
<script setup lang="ts">
import { cn } from "@/lib/utils";

const props = withDefaults(
  defineProps<{
    angle?: number;
    class?: string;
  }>(),
  {
    angle: 65,
  },
);
</script>

<template>
  <div
    :class="
      cn(
        'pointer-events-none absolute size-full overflow-hidden opacity-50 [perspective:200px]',
        props.class,
      )
    "
    :style="{
      '--grid-angle': `${props.angle}deg`,
    }"
  >
    <div class="absolute inset-0 [transform:rotateX(var(--grid-angle))]">
      <div
        :class="
          cn(
            'animate-grid',

            '[background-repeat:repeat] [background-size:60px_60px] [height:300vh] [inset:0%_0px] [margin-left:-50%] [transform-origin:100%_0_0] [width:600vw]',

            '[background-image:linear-gradient(to_right,rgba(0,0,0,0.3)_1px,transparent_0),linear-gradient(to_bottom,rgba(0,0,0,0.3)_1px,transparent_0)]',

            'dark:[background-image:linear-gradient(to_right,rgba(255,255,255,0.2)_1px,transparent_0),linear-gradient(to_bottom,rgba(255,255,255,0.2)_1px,transparent_0)]',
          )
        "
      />
    </div>
    <div
      class="absolute inset-0 bg-gradient-to-t from-white to-transparent dark:from-black to-90%"
    />
  </div>
</template>

Add the existing grid animation to theme.extend in tailwind.config.js:

tailwind.config.js
js
module.exports = {
  theme: {
    extend: {
      keyframes: {
        grid: {
          "0%": { transform: "translateY(-50%)" },
          "100%": { transform: "translateY(0)" },
        },
      },
      animation: { grid: "grid 15s linear infinite" },
    },
  },
};

Usage

vue
<script setup lang="ts">
import RetroGrid from "@/components/spark-ui/retro-grid/retro-grid.vue";
</script>

<template>
  <div class="relative h-80 overflow-hidden">
    <RetroGrid />
    <button type="button" class="relative">Explore</button>
  </div>
</template>

Behavior

The decorative grid is pointer-transparent and does not block controls placed beneath it.

Props

PropTypeDescriptionDefault
classstringThe class for the component""
anglenumberThe angle of the grid65

Released under the MIT License.