Skip to content

Latest commit

 

History

History
249 lines (203 loc) · 30.7 KB

README.md

File metadata and controls

249 lines (203 loc) · 30.7 KB

🍦 VanJS: The Smallest Reactive UI Framework in the World

📣 Introducing VanX →
📣 Introducing VanJS App Builder →

Enable everyone to build useful UI apps with a few lines of code, anywhere, any time, on any device.

VanJS is an ultra-lightweight, zero-dependency and unopinionated Reactive UI framework based on pure vanilla JavaScript and DOM. Programming with VanJS feels like building React apps in a scripting language, without JSX. Check-out the Hello World code below:

// Reusable components can be just pure vanilla JavaScript functions.
// Here we capitalize the first letter to follow React conventions.
const Hello = () => div(
  p("👋Hello"),
  ul(
    li("🗺️World"),
    li(a({href: "https://vanjs.org/"}, "🍦VanJS")),
  ),
)

van.add(document.body, Hello())
// Alternatively, you can write:
// document.body.appendChild(Hello())

Try on jsfiddle

You can convert any HTML or MD snippet into VanJS code with our online converter.

VanJS helps you manage states and UI bindings as well, with a more natural API:

const Counter = () => {
  const counter = van.state(0)
  return div(
    "❤️ ", counter, " ",
    button({onclick: () => ++counter.val}, "👍"),
    button({onclick: () => --counter.val}, "👎"),
  )
}

van.add(document.body, Counter())

Try on jsfiddle

Why VanJS?

Reactive Programming without React/JSX

Declarative DOM tree composition, reusable components, reactive state binding - VanJS offers every good aspect that React does, but without the need of React, JSX, transpiling, virtual DOM, or any hidden logic. Everything is built with simple JavaScript functions and DOM.

Grab 'n Go

No installation, no configuration, no dependencies, no transpiling, no IDE setups. Adding a line to your script or HTML file is all you need to start coding. And any code with VanJS can be pasted and executed directly in your browser's developer console. VanJS allows you to focus on the business logic of your application, rather than getting bogged down in frameworks and tools.

Ultra-Lightweight

VanJS is the smallest reactive UI framework in the world, with just 1.0kB in the gzipped minified bundle. It's 50~100 times smaller than most popular alternatives. Guess what you can get from this 1.0kB framework? All essential features of modern web frameworks - DOM templating, state, state binding, state derivation, effect, SPA, client-side routing and even hydration!

Size comparison

Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.

-- Antoine de Saint-Exupéry, Airman's Odyssey

Easy to Learn

Simplicity at its core. Only 5 functions (van.tags, van.add, van.state, van.derive, van.hydrate). The entire tutorial plus the API reference is just one single web page, and can be learned within 1 hour for most developers.

Performance

VanJS is among the fastest web frameworks, according to the results by krausest/js-framework-benchmark. For SSR, Mini-Van is 1.75X to 2.25X more efficient compared to React.

TypeScript Support

VanJS provides first-class support for TypeScript. With the .d.ts file in place, you'll be able to take advantage of type-checking, IntelliSense, large-scale refactoring provided by your preferred development environment. Refer to the Download Table to find the right .d.ts file to work with.

Want to Learn More?

IDE Plug-ins

See Also

A Guide to Reading VanJS Codebase

Support & Feedback

🙏 VanJS aims to build a better world by reducing the entry barrier of UI programming, with no intention or plan on commercialization whatsoever. If you find VanJS interesting, or could be useful for you some day, please consider starring the project. It takes just a few seconds but your support means the world to us and helps spread VanJS to a wider audience.

In the name of Vanilla of the House JavaScript, the First of its name, Smallest Reactive UI Framework, 1.0kB JSX-free Grab 'n Go Library, Scripting Language for GUI, GPT-Empowered Toolkit, by the word of Tao of the House Xin, Founder and Maintainer of VanJS, I do hereby grant you the permission of VanJS under MIT License.

Contact us: @taoxin / tao@vanjs.org / Tao Xin

Community Add-ons

VanJS can be extended via add-ons. Add-ons add more features to VanJS and/or provide an alternative styled API. Below is a curated list of add-ons built by VanJS community:

Add-on Description Author
Van Cone An SPA framework add-on for VanJS b-rad-c
van_element Web Components with VanJS Atmos4
VanJS Feather Feather Icons for VanJS thednp
van_dml.js A new flavour of composition for VanJS Eckehard
van-jsx A JSX wrapper for VanJS, for people who like the JSX syntax more cqh963852
vanjs-router A router solution for VanJS (README.md in simplified Chinese) 欧阳鹏
VanJS Routing Yet another routing solution for VanJS Kwame Opare Asiedu
VanJS Form Fully typed form state management library (with validation) for VanJS Kwame Opare Asiedu
vanjs-bootstrap VanJS Bootstrap Components Willi Commer
vanrx An ultra-lightweight Redux addon for VanJS Meddah Abdallah
VanFS 1:1 bindings from F# to VanJS Ken Okabe

Contributors (59)

If I miss anyone's contribution here, apologies for my oversight 🙏, please comment on #87 to let me know.

Emoji key

Tao Xin
Tao Xin

🎨 💻 📖 💡
Wei Sun
Wei Sun

🐛
Ryan Olson
Ryan Olson

🖋
Tamotsu Takahashi
Tamotsu Takahashi

💻
icecream17
icecream17

💻
enpitsulin
enpitsulin

💡 💻
Elliot Ford
Elliot Ford

💻
andrewgryan
andrewgryan

🎨 💻 🐛
FredericH
FredericH

💡 💻
ebraminio
ebraminio

💻 ⚠️
Eckehard
Eckehard

💻 🔌
Austin Merrick
Austin Merrick

💻 🤔 🎨
Lee Byonghun
Lee Byonghun

💻
caputdraconis
caputdraconis

💻
Achille Lacoin
Achille Lacoin

💻
cqh
cqh

💻 🔌
awesome
awesome

📹
artydev
artydev

💡 💬
Neven DREAN
Neven DREAN

💡 🐛
Stephen Handley
Stephen Handley

💡
Ionut Stoica
Ionut Stoica

🤔
Rasmus Schultz
Rasmus Schultz

🤔
cloudspeech
cloudspeech

🤔
Daniel Upshaw
Daniel Upshaw

🔌
barrymun
barrymun

💡
Giulio Malventi
Giulio Malventi

🖋 🐛
Yahia Berashish
Yahia Berashish

🐛 💻 🔌 🤔 💡
Phil Schumann
Phil Schumann

🐛
Raphaël Gauthier
Raphaël Gauthier

💻 🔌
Nail
Nail

💻 🔌
Brian Takita
Brian Takita

🐛 🤔
Jonny Fillmore
Jonny Fillmore

🐛
Lima Neto
Lima Neto

🖋
b rad c
b rad c

💻 🔌
欧阳鹏
欧阳鹏

🔌 📹
Daniel Mazurkiewicz
Daniel Mazurkiewicz

💻
Atmos4
Atmos4

💻 🔌
Kwame Opare Asiedu
Kwame Opare Asiedu

🔌 💡
ali-alnasser570
ali-alnasser570

🤔
Auryn Engel
Auryn Engel

📹
Samuel Wyndham
Samuel Wyndham

📹
sekoyo
sekoyo

🐛
Owen Furnell
Owen Furnell

🐛
MrVoltz
MrVoltz

🐛
Kane
Kane

💡
Vlad Sirenko
Vlad Sirenko

💡 💻
董凯
董凯

💡
Meddah Abdallah
Meddah Abdallah

🔌
Miroslaw
Miroslaw

🐛
Jon Nyman
Jon Nyman

🤔
ericraider33
ericraider33

🐛
Ken Okabe
Ken Okabe

🔌
Nick
Nick

💡
thednp
thednp

🔌
Bairui Su
Bairui Su

💻
jroush-ipg
jroush-ipg

🐛
kangaroolab
kangaroolab

💡
Graham Stratford
Graham Stratford

🐛
Kursat Aktas
Kursat Aktas

💻 🔌