Skip to content

Commit 2d37d2d

Browse files
[v2] docs: Add arrays docs and begin rework of references (#2325)
* add array docs rework * add API and fix reference generation * ci: apply automated fixes and generate docs * chore: apply suggestion and generate docs --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent d822f66 commit 2d37d2d

554 files changed

Lines changed: 2845 additions & 2162 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/arrays.md

Lines changed: 423 additions & 0 deletions
Large diffs are not rendered by default.

docs/config.json

Lines changed: 57 additions & 239 deletions
Large diffs are not rendered by default.

docs/framework/angular/guides/arrays.md

Lines changed: 0 additions & 144 deletions
This file was deleted.

docs/framework/angular/reference/classes/TanStackAppArrayField.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: TanStackAppArrayField
55

66
# Class: TanStackAppArrayField\<TSource, TFieldName, TFieldValue, TFieldValidators\>
77

8-
Defined in: [app-field.ts:37](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L37)
8+
Defined in: [app-field.ts:37](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L37)
99

1010
## Extends
1111

@@ -37,7 +37,7 @@ Defined in: [app-field.ts:37](https://github.com/TanStack/form/blob/main/package
3737
new TanStackAppArrayField<TSource, TFieldName, TFieldValue, TFieldValidators>(): TanStackAppArrayField<TSource, TFieldName, TFieldValue, TFieldValidators>;
3838
```
3939

40-
Defined in: [app-field.ts:56](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L56)
40+
Defined in: [app-field.ts:56](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L56)
4141

4242
#### Returns
4343

@@ -55,7 +55,7 @@ Defined in: [app-field.ts:56](https://github.com/TanStack/form/blob/main/package
5555
errorBoundary: InputSignal<boolean | undefined>;
5656
```
5757

58-
Defined in: [tanstack-field.ts:152](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L152)
58+
Defined in: [tanstack-field.ts:152](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L152)
5959

6060
#### Inherited from
6161

@@ -71,7 +71,7 @@ errorVisibility: InputSignal<
7171
| undefined>;
7272
```
7373

74-
Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L145)
74+
Defined in: [tanstack-field.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L145)
7575

7676
#### Inherited from
7777

@@ -85,7 +85,7 @@ Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/p
8585
protected readonly isArrayField: true = true;
8686
```
8787

88-
Defined in: [tanstack-field.ts:298](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L298)
88+
Defined in: [tanstack-field.ts:298](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L298)
8989

9090
#### Inherited from
9191

@@ -104,7 +104,7 @@ listeners: InputSignal<
104104
| undefined>;
105105
```
106106

107-
Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L128)
107+
Defined in: [tanstack-field.ts:128](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L128)
108108

109109
#### Inherited from
110110

@@ -118,7 +118,7 @@ Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/p
118118
name: InputSignal<TFieldName>;
119119
```
120120

121-
Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L126)
121+
Defined in: [tanstack-field.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L126)
122122

123123
#### Inherited from
124124

@@ -132,7 +132,7 @@ Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/p
132132
tanstackArrayField: InputSignal<TSource>;
133133
```
134134

135-
Defined in: [tanstack-field.ts:297](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L297)
135+
Defined in: [tanstack-field.ts:297](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L297)
136136

137137
#### Inherited from
138138

@@ -146,7 +146,7 @@ Defined in: [tanstack-field.ts:297](https://github.com/TanStack/form/blob/main/p
146146
validators: InputSignal<NoInfer<TFieldValidators> | undefined>;
147147
```
148148

149-
Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L127)
149+
Defined in: [tanstack-field.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L127)
150150

151151
#### Inherited from
152152

@@ -162,7 +162,7 @@ Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/p
162162
get api(): AngularSourceFieldApi<TSource, TFieldName, TFieldValue, TFieldValidators>;
163163
```
164164

165-
Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L190)
165+
Defined in: [tanstack-field.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L190)
166166

167167
##### Returns
168168

@@ -180,7 +180,7 @@ Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/p
180180
protected getSource(): TSource;
181181
```
182182

183-
Defined in: [tanstack-field.ts:299](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L299)
183+
Defined in: [tanstack-field.ts:299](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L299)
184184

185185
#### Returns
186186

docs/framework/angular/reference/classes/TanStackAppField.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: TanStackAppField
55

66
# Class: TanStackAppField\<TSource, TFieldName, TFieldValue, TFieldValidators\>
77

8-
Defined in: [app-field.ts:12](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L12)
8+
Defined in: [app-field.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L12)
99

1010
## Extends
1111

@@ -37,7 +37,7 @@ Defined in: [app-field.ts:12](https://github.com/TanStack/form/blob/main/package
3737
new TanStackAppField<TSource, TFieldName, TFieldValue, TFieldValidators>(): TanStackAppField<TSource, TFieldName, TFieldValue, TFieldValidators>;
3838
```
3939

40-
Defined in: [app-field.ts:26](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L26)
40+
Defined in: [app-field.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L26)
4141

4242
#### Returns
4343

@@ -55,7 +55,7 @@ Defined in: [app-field.ts:26](https://github.com/TanStack/form/blob/main/package
5555
errorBoundary: InputSignal<boolean | undefined>;
5656
```
5757

58-
Defined in: [tanstack-field.ts:152](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L152)
58+
Defined in: [tanstack-field.ts:152](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L152)
5959

6060
#### Inherited from
6161

@@ -71,7 +71,7 @@ errorVisibility: InputSignal<
7171
| undefined>;
7272
```
7373

74-
Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L145)
74+
Defined in: [tanstack-field.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L145)
7575

7676
#### Inherited from
7777

@@ -85,7 +85,7 @@ Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/p
8585
protected readonly isArrayField: false = false;
8686
```
8787

88-
Defined in: [tanstack-field.ts:271](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L271)
88+
Defined in: [tanstack-field.ts:271](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L271)
8989

9090
#### Inherited from
9191

@@ -104,7 +104,7 @@ listeners: InputSignal<
104104
| undefined>;
105105
```
106106

107-
Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L128)
107+
Defined in: [tanstack-field.ts:128](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L128)
108108

109109
#### Inherited from
110110

@@ -118,7 +118,7 @@ Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/p
118118
name: InputSignal<TFieldName>;
119119
```
120120

121-
Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L126)
121+
Defined in: [tanstack-field.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L126)
122122

123123
#### Inherited from
124124

@@ -132,7 +132,7 @@ Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/p
132132
tanstackField: InputSignal<TSource>;
133133
```
134134

135-
Defined in: [tanstack-field.ts:270](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L270)
135+
Defined in: [tanstack-field.ts:270](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L270)
136136

137137
#### Inherited from
138138

@@ -146,7 +146,7 @@ Defined in: [tanstack-field.ts:270](https://github.com/TanStack/form/blob/main/p
146146
validators: InputSignal<NoInfer<TFieldValidators> | undefined>;
147147
```
148148

149-
Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L127)
149+
Defined in: [tanstack-field.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L127)
150150

151151
#### Inherited from
152152

@@ -162,7 +162,7 @@ Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/p
162162
get api(): AngularSourceFieldApi<TSource, TFieldName, TFieldValue, TFieldValidators>;
163163
```
164164

165-
Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L190)
165+
Defined in: [tanstack-field.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L190)
166166

167167
##### Returns
168168

@@ -180,7 +180,7 @@ Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/p
180180
protected getSource(): TSource;
181181
```
182182

183-
Defined in: [tanstack-field.ts:272](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L272)
183+
Defined in: [tanstack-field.ts:272](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L272)
184184

185185
#### Returns
186186

0 commit comments

Comments
 (0)