---
title: Introduction
description: An unofficial guide to contributing to Svelte Bits, the library of animated Svelte components ported from React Bits.
url: https://sveltebits.thally.app/
---

# Introduction

An unofficial guide to contributing to Svelte Bits, the library of animated Svelte components ported from React Bits.

## What Svelte Bits is

[Svelte Bits](https://sveltebits.xyz) is a free library of animated Svelte
components: text effects, backgrounds, cursor effects and UI pieces you copy into
your own project. It's the Svelte port of [React Bits](https://github.com/DavidHDev/react-bits),
created and maintained by [David Haz](https://github.com/DavidHDev). At the time of
writing it has 164 components.

If you only want to **use** the components, the [official docs](https://sveltebits.xyz/get-started/installation)
cover installation. This guide is for people who want to **add** them.

## Why it needs contributors

React Bits keeps growing, and Svelte Bits catches up one port at a time. Each port
is a self-contained piece of work: one component, its demo page and a few lines of
registration. That makes it a good first open-source contribution if you know
Svelte 5.

## Who this is for

Svelte developers who:

- are comfortable with Svelte 5 runes (`$props`, `$state`, `$effect`)
- can read React and TypeScript well enough to follow what a component does
- want their work reviewed and merged into a project people use

## The one rule

The project's README is clear about what matters most:

> Component ports must preserve the upstream implementation as closely as possible,
> including dependencies, shaders, spring configs, props, and behavior.

A port is a translation, not a redesign. Same props, same defaults, same feel.

## What a contribution involves

Each port touches a handful of files: the component itself, a demo page, and two
registration files. A registry build then generates the install files for you. The
[porting guide](/guides/port-a-component) walks through every one, using a real
merged port as the example.

> **Note:**
	This is an **unofficial community guide**, written by a contributor with
	merged ports
	([CursorGrid](https://github.com/DavidHDev/svelte-bits/pulls?q=is%3Apr+author%3Aadetyaz),
	MaskedHeading and ScrollExpand). It is loosely affiliated with the Svelte Bits
	project. When in doubt, the
	[repository](https://github.com/DavidHDev/svelte-bits) and the maintainer's
	review are the source of truth.

## Next step

#### [Run Svelte Bits locally](/quickstart)

		Clone the repo and see a component running on your machine in about 10
		minutes.