-
-
Notifications
You must be signed in to change notification settings - Fork 520
Update README #1734
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update README #1734
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a4c244b
update readme
LadyBluenotes 37f133b
add form features
LadyBluenotes c398375
Merge branch 'main' into fix-readme
LadyBluenotes b94f17a
ci: apply automated fixes and generate docs
autofix-ci[bot] d817453
Update README.md
LadyBluenotes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,107 @@ | ||
| <img src="https://static.scarf.sh/a.png?x-pxid=be2d8a11-9712-4c1d-9963-580b2d4fb133" alt="" /> | ||
| <div align="center"> | ||
| <img src="./media/header_form.png" > | ||
| </div> | ||
|
|
||
|  | ||
| <br /> | ||
|
|
||
| Powerful and type-safe form state management for the web. TS/JS, React Form, Solid Form, Angular Form, Lit Form and Vue | ||
| Form. | ||
|
|
||
| <a href="https://twitter.com/intent/tweet?button_hashtag=TanStack" target="_parent"> | ||
| <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"> | ||
| </a><a href="https://discord.com/invite/WrRKjPJ" target="_parent"> | ||
| <img alt="Join the TanStack Discord Community" src="https://img.shields.io/badge/Discord-TanStack-%235865F2" /> | ||
| </a><a href="https://www.npmjs.com/package/@tanstack/form-core" target="_parent"> | ||
| <div align="center"> | ||
| <a href="https://www.npmjs.com/package/@tanstack/form-core" target="_parent"> | ||
| <img alt="NPM downloads for @tanstack/form-core" src="https://img.shields.io/npm/dm/@tanstack/form-core.svg" /> | ||
| </a><a href="https://bundlephobia.com/package/@tanstack/form-core@latest" target="_parent"> | ||
| </a> | ||
| <a href="https://github.com/TanStack/form/" target="_parent"> | ||
| <img alt="Star TanStack Form on GitHub" src="https://img.shields.io/github/stars/TanStack/form.svg?style=social&label=Star" /> | ||
| </a> | ||
| <a href="https://bundlephobia.com/package/@tanstack/form-core@latest" target="_parent"> | ||
| <img alt="Minified + gzipped bundle size of @tanstack/form-core" src="https://badgen.net/bundlephobia/minzip/@tanstack/form-core" /> | ||
| </a><a href="#badge"> | ||
| </a> | ||
| </div> | ||
|
|
||
| <div align="center"> | ||
| <a href="#badge"> | ||
| <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"> | ||
| </a><a href="https://github.com/TanStack/form/discussions"> | ||
| <img alt="Join GitHub Discussions for TanStack Form" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" /> | ||
| </a><a href="https://bestofjs.org/projects/tanstack-form"> | ||
| </a> | ||
| <a href="https://bestofjs.org/projects/tanstack-form"> | ||
| <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" /> | ||
| </a><a href="https://github.com/TanStack/form/" target="_parent"> | ||
| <img alt="Star TanStack Form on GitHub" src="https://img.shields.io/github/stars/TanStack/form.svg?style=social&label=Star" /> | ||
| </a><a href="https://twitter.com/tannerlinsley" target="_parent"> | ||
| <img alt="Follow Tanner Linsley on Twitter" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" /> | ||
| </a><a href="https://gitpod.io/from-referrer/"> | ||
| <img alt="Open TanStack Form in Gitpod" src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" /> | ||
| </a> | ||
| <a href="https://twitter.com/tan_stack"> | ||
| <img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/> | ||
| </a> | ||
| </div> | ||
|
|
||
| Enjoy this library? Try the | ||
| 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) | ||
| <div align="center"> | ||
|
|
||
| ### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/) | ||
| </div> | ||
|
|
||
| ## Visit [tanstack.com/form](https://tanstack.com/form) for docs, guides, API and more! | ||
| # TanStack Form | ||
|
|
||
| ### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/) | ||
| A headless form library for managing complex form state with full control over fields, validation, and workflows across any framework. | ||
|
|
||
| - Framework‑agnostic & headless — bring your own UI | ||
| - Fully typed with TypeScript | ||
| - Reactive hooks & extensible modular architecture | ||
| - Sync & async validation with debouncing and nested fields | ||
|
|
||
| ### <a href="https://tanstack.com/form">Read the docs →</b></a> | ||
|
|
||
| <br /> | ||
|
|
||
| ## Get Involved | ||
|
|
||
| - We welcome issues and pull requests! | ||
| - Participate in [GitHub discussions](https://github.com/TanStack/form/discussions) | ||
| - Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ) | ||
| - See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions | ||
|
|
||
| ## Partners | ||
|
|
||
| <table align="center"> | ||
| <tr> | ||
| <td> | ||
| <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-CMcuvjEy.svg" height="40" /> | ||
| <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" /> | ||
| <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" /> | ||
| </picture> | ||
| </a> | ||
| </td> | ||
| <td padding="20"> | ||
| <a href="https://www.cloudflare.com?utm_source=tanstack"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-DQDB7UaL.svg" height="60" /> | ||
| <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" /> | ||
| <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" /> | ||
| </picture> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <div align="center"> | ||
| <img src="./media/partner_logo.svg" alt="Form & you?" height="65"> | ||
| <p> | ||
| 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. | ||
| </p> | ||
| <a href="mailto:partners@tanstack.com?subject=TanStack Form Partnership"><b>LET'S CHAT</b></a> | ||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
| ## Explore the TanStack Ecosystem | ||
|
|
||
| - <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages | ||
| - <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store | ||
| - <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel | ||
| - <a href="https://github.com/tanstack/pacer"><b>TanStack Pacer</b></a> – Debouncing, throttling, batching <br/> | ||
| - <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching | ||
| - <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives | ||
| - <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state | ||
| - <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming | ||
| - <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store | ||
| - <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids | ||
| - <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering | ||
|
|
||
| … and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a> | ||
|
|
||
| <!-- Use the force, Luke! --> | ||
| <!-- USE THE FORCE LUKE --> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The logos of partners are hard to read with dark mode. This also seems to happen with other packages like TanStack Router. Do you think it's fine?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I'm not quite sure how to solve this, I noticed it during the previews. I might have to see what people suggest.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good.
The router preview for reference:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd assume the best option is to add a white background to them??? At the moment, I'm pulling most of the logos from the tanstack site / whatever was pre-existing.
Mostly didn't want to add a bunch of images to the media folders of all repos, but that may be the only option
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably. Either way, it's not blocking this PR, so I'll merge it