docs: typedoc generation

* docs: initial work on implementing typedoc * docs: migrate to use formApi reference typedoc comments * chore: document FieldAPI from docs * chore: remove prefix to showcase file types * chore: migrate reference docs to take multiple paths * chore: add external and cleanup * chore: add lit and cleanup rm usage * chore: add manual docs to ts files themselves * chore: add React to reference docs * chore: add solid and vue code samples * chore: fix typedoc generations
TanStack · Jun 20, 2024 · 33eacda · 33eacda
1 parent a646dcd
commit 33eacda
Show file tree

Hide file tree

Showing 75 changed files with 4,151 additions and 997 deletions.
diff --git a/docs/config.json b/docs/config.json
@@ -160,85 +160,78 @@
     {
       "label": "API Reference",
       "children": [
-        {
-          "label": "FormApi",
-          "to": "reference/formApi"
-        },
-        {
-          "label": "FieldApi",
-          "to": "reference/fieldApi"
-        },
-        {
-          "label": "Types",
-          "to": "reference/types"
-        }
+        {"label": "JavaScript Reference", "to": "reference/index"},
+        {"label": "Classes / FieldApi", "to": "reference/fieldapi"},
+        {"label": "Classes / FormApi", "to": "reference/formapi"},
+        {"label": "Functions / formOptions", "to": "reference/formoptions"},
+        {"label": "Functions / mergeForm", "to": "reference/mergeform"},
+        {"label": "Interfaces / FieldApiOptions", "to": "reference/fieldapioptions"},
+        {"label": "Interfaces / FieldOptions", "to": "reference/fieldoptions"},
+        {"label": "Interfaces / FieldValidators", "to": "reference/fieldvalidators"},
+        {"label": "Interfaces / FormOptions", "to": "reference/formoptions"},
+        {"label": "Interfaces / FormValidators", "to": "reference/formvalidators"},
+        {"label": "Types / DeepKeys", "to": "reference/deepkeys"},
+        {"label": "Types / DeepValue", "to": "reference/deepvalue"},
+        {"label": "Types / FieldInfo", "to": "reference/fieldinfo"},
+        {"label": "Types / FieldMeta", "to": "reference/fieldmeta"},
+        {"label": "Types / FieldState", "to": "reference/fieldstate"},
+        {"label": "Types / FormState", "to": "reference/formstate"},
+        {"label": "Types / Updater", "to": "reference/updater"},
+        {"label": "Types / UpdaterFn", "to": "reference/updaterfn"},
+        {"label": "Types / ValidationError", "to": "reference/validationerror"},
+        {"label": "Types / ValidationMeta", "to": "reference/validationmeta"}
       ],
       "frameworks": [
         {
           "label": "react",
           "children": [
-            {
-              "label": "useForm",
-              "to": "framework/react/reference/useForm"
-            },
-            {
-              "label": "useField",
-              "to": "framework/react/reference/useField"
-            },
-            {
-              "label": "Field",
-              "to": "framework/react/reference/Field"
-            },
-            {
-              "label": "FormApi",
-              "to": "framework/react/reference/formApi"
-            },
-            {
-              "label": "FieldApi",
-              "to": "framework/react/reference/fieldApi"
-            }
+            {"label": "React Reference", "to": "framework/react/reference/index"},
+            {"label": "Functions / createServerValidate", "to": "framework/react/reference/createservervalidate"},
+            {"label": "Functions / Field", "to": "framework/react/reference/field"},
+            {"label": "Functions / useField", "to": "framework/react/reference/usefield"},
+            {"label": "Functions / useForm", "to": "framework/react/reference/useform"},
+            {"label": "Functions / useTransform", "to": "framework/react/reference/usetransform"},
+            {"label": "Types / FieldComponent", "to": "framework/react/reference/fieldcomponent"},
+            {"label": "Types / UseField", "to": "framework/react/reference/usefield"},
+            {"label": "Variables / initialFormState", "to": "framework/react/reference/initialformstate"}
           ]
         },
         {
           "label": "vue",
           "children": [
-            {
-              "label": "useForm",
-              "to": "framework/vue/reference/useForm"
-            },
-            {
-              "label": "useField",
-              "to": "framework/vue/reference/useField"
-            },
-            {
-              "label": "Field",
-              "to": "framework/vue/reference/Field"
-            },
-            {
-              "label": "FormApi",
-              "to": "framework/vue/reference/formApi"
-            }
+            {"label": "Vue Reference", "to": "framework/vue/reference/index"},
+            {"label": "Functions / Field", "to": "framework/vue/reference/field"},
+            {"label": "Functions / useField", "to": "framework/vue/reference/usefield"},
+            {"label": "Functions / useForm", "to": "framework/vue/reference/useform"},
+            {"label": "Types / FieldComponent", "to": "framework/vue/reference/fieldcomponent"},
+            {"label": "Types / UseField", "to": "framework/vue/reference/usefield"}
           ]
         },
         {
           "label": "solid",
           "children": [
-            {
-              "label": "useForm",
-              "to": "framework/solid/reference/createForm"
-            },
-            {
-              "label": "useField",
-              "to": "framework/solid/reference/createField"
-            },
-            {
-              "label": "Field",
-              "to": "framework/solid/reference/Field"
-            },
-            {
-              "label": "FormApi",
-              "to": "framework/solid/reference/formApi"
-            }
+            {"label": "Solid Reference", "to": "framework/solid/reference/index"},
+            {"label": "Functions / createField", "to": "framework/solid/reference/createfield"},
+            {"label": "Functions / createForm", "to": "framework/solid/reference/createform"},
+            {"label": "Functions / Field", "to": "framework/solid/reference/field"},
+            {"label": "Types / CreateField", "to": "framework/solid/reference/createfield"},
+            {"label": "Types / FieldComponent", "to": "framework/solid/reference/fieldcomponent"}
+          ]
+        },
+        {
+          "label": "lit",
+          "children": [
+            {"label": "Lit Reference", "to": "framework/lit/reference/index"},
+            {"label": "Classes / TanStackFormController", "to": "framework/lit/reference/tanstackformcontroller"}
+          ]
+        },
+        {
+          "label": "angular",
+          "children": [
+            {"label": "Angular Reference", "to": "framework/angular/reference/index"},
+            {"label": "Classes / TanStackField", "to": "framework/angular/reference/tanstackfield"},
+            {"label": "Functions / injectForm", "to": "framework/angular/reference/injectform"},
+            {"label": "Functions / injectStore", "to": "framework/angular/reference/injectstore"},
           ]
         }
       ]

diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md
@@ -0,0 +1,10 @@
+# @tanstack/angular-form
+
+## Classes
+
+- [TanStackField](tanstackfield.md)
+
+## Functions
+
+- [injectForm](injectform.md)
+- [injectStore](injectstore.md)
diff --git a/docs/framework/angular/reference/injectform.md b/docs/framework/angular/reference/injectform.md
@@ -0,0 +1,23 @@
+# Function: injectForm()
+
+```ts
+function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormValidator>
+```
+
+## Type parameters
+
+• **TFormData**
+
+• **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined`
+
+## Parameters
+
+• **opts?**: `FormOptions`\<`TFormData`, `TFormValidator`\>
+
+## Returns
+
+`FormApi`\<`TFormData`, `TFormValidator`\>
+
+## Source
+
+[inject-form.ts:4](https://github.com/TanStack/form/blob/5c94fa159313e0b0411d49fbdc3b117336185e63/packages/angular-form/src/inject-form.ts#L4)
diff --git a/docs/framework/angular/reference/injectstore.md b/docs/framework/angular/reference/injectstore.md
@@ -0,0 +1,27 @@
+# Function: injectStore()
+
+```ts
+function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Signal<TSelected>
+```
+
+## Type parameters
+
+• **TFormData**
+
+• **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined`
+
+• **TSelected** = `NoInfer`\<`FormState`\<`TFormData`\>\>
+
+## Parameters
+
+• **form**: `FormApi`\<`TFormData`, `TFormValidator`\>
+
+• **selector?**
+
+## Returns
+
+`Signal`\<`TSelected`\>
+
+## Source
+
+[inject-store.ts:4](https://github.com/TanStack/form/blob/5c94fa159313e0b0411d49fbdc3b117336185e63/packages/angular-form/src/inject-store.ts#L4)