Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

FieldGroupFieldSlot.md

53 lines1.5 KB

1---
2id: FieldGroupFieldSlot
3title: FieldGroupFieldSlot
4---
5​
6Defined in: [FieldGroup/fieldGroupTypes.public.ts:27](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroup/fieldGroupTypes.public.ts#L27)
7​
8Describes the value type and matching rule for one virtual field in a
9reusable field group.
10​
11Slots are type markers consumed by a field-group definition. Their
12properties are not available at runtime.
13​
14Create slots with `FieldGroupHelper.strict` or `FieldGroupHelper.loose`
15inside a field-group definition instead of constructing them directly.
16​
17## Type Parameters
18​
19### TValue
20​
21`TValue`
22​
23The value type declared for the virtual field.
24​
25### TMode
26​
27`TMode` *extends* [`FieldGroupFieldSlotMode`](../type-aliases/FieldGroupFieldSlotMode.md) = [`FieldGroupFieldSlotMode`](../type-aliases/FieldGroupFieldSlotMode.md)
28​
29Library-managed. Do not specify explicitly.
30​
31## Properties
32​
33### \[fieldGroupFieldSlotValueSymbol\]
34​
35```ts
36readonly [fieldGroupFieldSlotValueSymbol]: TValue;
37```
38​
39Defined in: [FieldGroup/fieldGroupTypes.public.ts:34](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroup/fieldGroupTypes.public.ts#L34)
40​
41Preserves the declared value type for type-level inference.
42​
43***
44​
45### mode
46​
47```ts
48readonly mode: TMode;
49```
50​
51Defined in: [FieldGroup/fieldGroupTypes.public.ts:32](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroup/fieldGroupTypes.public.ts#L32)
52​
53Represents the slot's value-type matching rule at the type level.