Skip to content

Commit 6892ed0

Browse files
Update README (#1734)
* update readme * add form features * ci: apply automated fixes and generate docs * Update README.md --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 5d1443f commit 6892ed0

File tree

3 files changed

+122
-26
lines changed

3 files changed

+122
-26
lines changed

README.md

Lines changed: 96 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,107 @@
1-
<img src="https://static.scarf.sh/a.png?x-pxid=be2d8a11-9712-4c1d-9963-580b2d4fb133" alt="" />
1+
<div align="center">
2+
<img src="./media/header_form.png" >
3+
</div>
24

3-
![TanStack Form Header](https://github.com/TanStack/form/raw/main/media/repo-header.png)
5+
<br />
46

5-
Powerful and type-safe form state management for the web. TS/JS, React Form, Solid Form, Angular Form, Lit Form and Vue
6-
Form.
7-
8-
<a href="https://twitter.com/intent/tweet?button_hashtag=TanStack" target="_parent">
9-
<img alt="Tweet about TanStack with hashtag #TanStack" src="https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack">
10-
</a><a href="https://discord.com/invite/WrRKjPJ" target="_parent">
11-
<img alt="Join the TanStack Discord Community" src="https://img.shields.io/badge/Discord-TanStack-%235865F2" />
12-
</a><a href="https://www.npmjs.com/package/@tanstack/form-core" target="_parent">
7+
<div align="center">
8+
<a href="https://www.npmjs.com/package/@tanstack/form-core" target="_parent">
139
<img alt="NPM downloads for @tanstack/form-core" src="https://img.shields.io/npm/dm/@tanstack/form-core.svg" />
14-
</a><a href="https://bundlephobia.com/package/@tanstack/form-core@latest" target="_parent">
10+
</a>
11+
<a href="https://github.com/TanStack/form/" target="_parent">
12+
<img alt="Star TanStack Form on GitHub" src="https://img.shields.io/github/stars/TanStack/form.svg?style=social&label=Star" />
13+
</a>
14+
<a href="https://bundlephobia.com/package/@tanstack/form-core@latest" target="_parent">
1515
<img alt="Minified + gzipped bundle size of @tanstack/form-core" src="https://badgen.net/bundlephobia/minzip/@tanstack/form-core" />
16-
</a><a href="#badge">
16+
</a>
17+
</div>
18+
19+
<div align="center">
20+
<a href="#badge">
1721
<img alt="Semantic Release Enabled" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
18-
</a><a href="https://github.com/TanStack/form/discussions">
19-
<img alt="Join GitHub Discussions for TanStack Form" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
20-
</a><a href="https://bestofjs.org/projects/tanstack-form">
22+
</a>
23+
<a href="https://bestofjs.org/projects/tanstack-form">
2124
<img alt="TanStack Form featured on Best of JS" src="https://img.shields.io/endpoint?url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=TanStack%2Fform%26since=daily" />
22-
</a><a href="https://github.com/TanStack/form/" target="_parent">
23-
<img alt="Star TanStack Form on GitHub" src="https://img.shields.io/github/stars/TanStack/form.svg?style=social&label=Star" />
24-
</a><a href="https://twitter.com/tannerlinsley" target="_parent">
25-
<img alt="Follow Tanner Linsley on Twitter" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
26-
</a><a href="https://gitpod.io/from-referrer/">
27-
<img alt="Open TanStack Form in Gitpod" src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" />
2825
</a>
26+
<a href="https://twitter.com/tan_stack">
27+
<img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
28+
</a>
29+
</div>
2930

30-
Enjoy this library? Try the
31-
entire [TanStack](https://tanstack.com)! [TanStack Query](https://github.com/TanStack/query), [TanStack Table](https://github.com/TanStack/table), [TanStack Router](https://github.com/tanstack/router), [TanStack Virtual](https://github.com/tanstack/virtual), [React Charts](https://github.com/TanStack/react-charts), [React Ranger](https://github.com/TanStack/ranger)
31+
<div align="center">
32+
33+
### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
34+
</div>
3235

33-
## Visit [tanstack.com/form](https://tanstack.com/form) for docs, guides, API and more!
36+
# TanStack Form
3437

35-
### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
38+
A headless form library for managing complex form state with full control over fields, validation, and workflows across any framework.
39+
40+
- Framework‑agnostic & headless — bring your own UI
41+
- Fully typed with TypeScript
42+
- Reactive hooks & extensible modular architecture
43+
- Sync & async validation with debouncing and nested fields
44+
45+
### <a href="https://tanstack.com/form">Read the docs →</b></a>
46+
47+
<br />
48+
49+
## Get Involved
50+
51+
- We welcome issues and pull requests!
52+
- Participate in [GitHub discussions](https://github.com/TanStack/form/discussions)
53+
- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
54+
- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
55+
56+
## Partners
57+
58+
<table align="center">
59+
<tr>
60+
<td>
61+
<a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS">
62+
<picture>
63+
<source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-CMcuvjEy.svg" height="40" />
64+
<source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" />
65+
<img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
66+
</picture>
67+
</a>
68+
</td>
69+
<td padding="20">
70+
<a href="https://www.cloudflare.com?utm_source=tanstack">
71+
<picture>
72+
<source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-DQDB7UaL.svg" height="60" />
73+
<source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" />
74+
<img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
75+
</picture>
76+
</a>
77+
</td>
78+
</tr>
79+
</table>
80+
81+
<div align="center">
82+
<img src="./media/partner_logo.svg" alt="Form & you?" height="65">
83+
<p>
84+
We're looking for TanStack Form Partners to join our mission! Partner with us to push the boundaries of TanStack Form and build amazing things together.
85+
</p>
86+
<a href="mailto:partners@tanstack.com?subject=TanStack Form Partnership"><b>LET'S CHAT</b></a>
87+
</div>
88+
89+
</div>
90+
91+
## Explore the TanStack Ecosystem
92+
93+
- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
94+
- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
95+
- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
96+
- <a href="https://github.com/tanstack/pacer"><b>TanStack Pacer</b></a> – Debouncing, throttling, batching <br/>
97+
- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
98+
- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
99+
- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
100+
- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
101+
- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
102+
- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
103+
- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
104+
105+
… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>
36106

37-
<!-- Use the force, Luke! -->
107+
<!-- USE THE FORCE LUKE -->

media/header_form.png

122 KB
Loading

media/partner_logo.svg

Lines changed: 26 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)