Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
tannerlinsley committed Apr 28, 2023
1 parent c0888da commit fa75027
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 43 deletions.
22 changes: 15 additions & 7 deletions docs/comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: comparison
title: Comparison | TanStack Form
---

> This comparison table strives to be as accurate and as unbiased as possible. If you use any of these libraries and feel the information could be improved, feel free to suggest changes (with notes or evidence of claims) using the "Edit this page on Github" link at the bottom of this page.
> ⚠️ This comparison table is under construction and is still not completely accurate. If you use any of these libraries and feel the information could be improved, feel free to suggest changes (with notes or evidence of claims) using the "Edit this page on Github" link at the bottom of this page.
Feature/Capability Key:

Expand All @@ -12,12 +12,20 @@ Feature/Capability Key:
- 🔶 Supported and documented, but requires extra user-code to implement
- 🛑 Not officially supported or documented.

| | TanStack Form |
| -------------------- | -------------------------------------------- |
| Github Repo / Stars | [![][stars-tanstack-form]][gh-tanstack-form] |
| Supported Frameworks | React |
| Bundle Size | [![][bp-tanstack-form]][bpl-tanstack-form] |
| TODO | |
| Feature | TanStack Form | Formik | Redux Form | React Hook Form | Final Form |
| ------------------------------------------------- | -------------------------------------------- | ------ | ---------- | --------------- | ---------- |
| Github Repo / Stars | [![][stars-tanstack-form]][gh-tanstack-form] | | | | |
| Supported Frameworks | React | | | | |
| Bundle Size | [![][bp-tanstack-form]][bpl-tanstack-form] | | | | |
| First-class TypeScript support ||||||
| Fully Inferred TypeScript (Including Deep Fields) ||||||
| Headless UI components ||||||
| Framework agnostic ||||||
| Granular reactivity ||||||
| Nested object/array fields ||||||
| Async validation ||||||
| Built-in async validation debounce ||||||
| Schema-based Validation | 🔶 |||||

[bpl-tanstack-form]: https://bundlephobia.com/result?p=@tanstack/react-form
[bp-tanstack-form]: https://badgen.net/bundlephobia/minzip/@tanstack/react-form?label=💾
Expand Down
39 changes: 3 additions & 36 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,14 @@ id: installation
title: Installation
---

You can install TanStack Form via [NPM](https://npmjs.com),
or a good ol' `<script>` via
[unpkg.com](https://unpkg.com).

### NPM
TanStack Form is compatible with various front-end frameworks, including React, Solid, Svelte and Vue. To use TanStack Form with your desired framework, install the corresponding adapter via NPM

```bash
$ npm i @tanstack/react-form
# or
$ pnpm add @tanstack/react-form
$ pnpm add @tanstack/solid-form
# or
$ yarn add @tanstack/react-form
```

TanStack Form is compatible with React v16.8+ and works with ReactDOM and React Native.

> Wanna give it a spin before you download? Try out the [simple](/form/v1/docs/examples/react/simple) or [basic](/form/v1/docs/examples/react/basic) examples!
### CDN

If you're not using a module bundler or package manager we also have a global ("UMD") build hosted on the [unpkg.com](https://unpkg.com) CDN. Simply add the following `<script>` tag to the bottom of your HTML file:

```html
<script src="https://unpkg.com/@tanstack/react-form@4/build/umd/index.production.js"></script>
```

Once you've added this you will have access to the `window.ReactForm` object and its exports.

> This installation/usage requires the [React CDN script bundles](https://reactjs.org/docs/cdn-links.html) to be on the page as well.
### Requirements

TanStack Form is optimized for modern browsers. It is compatible with the following browsers config

```
Chrome >= 73
Firefox >= 78
Edge >= 79
Safari >= 12.0
iOS >= 12.0
opera >= 53
$ yarn add @tanstack/svelte-form
```

> Depending on your environment, you might need to add polyfills. If you want to support older browsers, you need to transpile the library from `node_modules` yourselves.

0 comments on commit fa75027

Please sign in to comment.