README

!Preact



Fast 4kB alternative to React with the same modern API.

All the power of Virtual DOM components, without the overhead:

- Familiar React API & patterns: ES6 Class, hooks, and Functional Components
- Extensive React compatibility via a simple [preact/compat] alias
- Everything you need: JSX, VDOM, [DevTools], HMR, SSR.
- Highly optimized diff algorithm and seamless hydration from Server Side Rendering
- Supports all modern browsers
- Transparent asynchronous rendering with a pluggable scheduler

 💁 More information at the Preact Website ➞




















You can find some awesome libraries in the awesome-preact list :sunglasses:

---

 Getting Started

 💁 _Note: You don't need ES2015 to use Preact... but give it a try!_

 Tutorial: Building UI with Preact

With Preact, you create user interfaces by assembling trees of components and elements. Components are functions or classes that return a description of what their tree should output. These descriptions are typically written in JSX (shown underneath), or HTM which leverages standard JavaScript Tagged Templates. Both syntaxes can express trees of elements with "props" (similar to HTML attributes) and children.

To get started using Preact, first look at the render() function. This function accepts a tree description and creates the structure described. Next, it appends this structure to a parent DOM element provided as the second argument. Future calls to render() will reuse the existing tree and update it in-place in the DOM. Internally, render() will calculate the difference from previous outputted structures in an attempt to perform as few DOM operations as possible.

js
import { h, render } from 'preact';
// Tells babel to use h for JSX. It's better to configure this globally.
// See https://babeljs.io/docs/en/babel-plugin-transform-react-jsxusage
// In tsconfig you can specify this with the jsxFactory
/ @jsx h /

// create our tree and append it to document.body:
render(
	
		Hello
	,
	document.body
);

// update the tree in-place:
render(
	
		Hello World!
	,
	document.body
);
// ^ this second invocation of render(...) will use a single DOM call to update the text of the 


Hooray! render() has taken our structure and output a User Interface! This approach demonstrates a simple case, but would be difficult to use as an application grows in complexity. Each change would be forced to calculate the difference between the current and updated structure for the entire application. Components can help here – by dividing the User Interface into nested Components each can calculate their difference from their mounted point. Here's an example:

js
import { render, h } from 'preact';
import { useState } from 'preact/hooks';

/ @jsx h /

const App = () = {
	const [input, setInput] = useState('');

	return (
		
			Do you agree to the statement: "Preact is awesome"?
			 setInput(e.target.value)} /
		
	);
};

render(, document.body);


---

 Sponsors

Become a sponsor and get your logo on ou

Top issues

Discussions

Latest release

Features

- Support scoped custom element registries when rendering into shadow roots (5342, thanks @JoviDeCroock)

 Fixes

- Ignore non-function values for on props instead of registering invalid event handlers (5345, thanks @JoviDeCroock)
- Pass a thrown null or undefined to error boundaries without replacing it with a TypeError (5347, thanks @jonkwheeler)
- Preserve event handlers on unmounted nodes so events already bubbling can finish (5349, thanks @JoviDeCroock)

 Performance

- Reduce bundle size across core, hooks, and compat (5343, thanks @JoviDeCroock)