collection-form

Interfaces

CollectionFormComposition

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:44

Type Parameters

Type Parameter
TCollections extends CollectionRegistry
TName extends CollectionFormName<TCollections>

Properties

Field

Field: Component<CollectionFormFieldProps<Extract<keyof CollectionRow<TCollections[TName]>, string>>>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:45

form

form: CollectionFormController;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:46

---

CollectionFormController

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:35

Properties

setValues

readonly setValues: (values) => void;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:37

Parameters

Parameter	Type
values	CollectionFormValidationValues

Returns

void

values

readonly values: () => CollectionFormValidationValues;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:36

Returns

CollectionFormValidationValues

---

CollectionFormDeleteAction

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:39

Properties

disabled?

readonly optional disabled?: boolean;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:41

label?

readonly optional label?: string;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:40

onDelete

readonly onDelete: () => void | Promise<void>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:42

Returns

void | Promise<void>

---

CollectionFormFieldProps

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:16

Type Parameters

Type Parameter	Default type
TFieldName extends string	string

Properties

class?

optional class?: string;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:19

label?

optional label?: string;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:18

name

name: TFieldName;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:17

renderer?

optional renderer?: Component<CollectionFormRendererProps, {
}, string>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:20

rendererProps?

optional rendererProps?: CollectionFormRendererOptions;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:21

---

CollectionFormProps

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:48

Type Parameters

Type Parameter
TCollections extends CollectionRegistry
TName extends CollectionFormName<TCollections>

Properties

children?

optional children?: Snippet<[CollectionFormComposition<TCollections, TName>]>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:71

Field composition. Omit to auto-emit a Field per writable field in declaration order and laid out with the intrinsic Grid (RFC V.4a).

class?

optional class?: string;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:60

client

client: CollectionClient<TCollections>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:49

collectionName

collectionName: TName;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:50

defaultValues?

optional defaultValues?: 
  | Partial<CollectionRow<TCollections[TName]>>
  | Partial<CollectionCreateInput<TCollections[TName]>>
| Partial<CollectionUpdateInput<TCollections[TName]>>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:51

deleteAction?

optional deleteAction?: CollectionFormDeleteAction;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:56

disabled?

optional disabled?: boolean;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:57

fields?

optional fields?: readonly Extract<keyof CollectionRow<TCollections[TName]>, string>[];

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:66

Ordered field-name pick for the auto-emitted form (RFC V.4b). Wins over auto field emission; ignored when a children composition is provided.

loading?

optional loading?: boolean;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:58

onAfterSubmit?

optional onAfterSubmit?: (record) => void | Promise<void>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:61

Parameters

Parameter	Type
record	CollectionRow<TCollections[TName]>

Returns

void | Promise<void>

onSubmit?

optional onSubmit?: (values) => 
  | CollectionRow<TCollections[TName]>
| Promise<CollectionRow<TCollections[TName]>>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:55

Parameters

Parameter	Type
values	CollectionFormValidationValues

Returns

| CollectionRow<TCollections[TName]> | Promise<CollectionRow<TCollections[TName]>>

recordId?

optional recordId?: string;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:52

skeletonRows?

optional skeletonRows?: number;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:59

submitLabel?

optional submitLabel?: string;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:53

validation?

optional validation?: CollectionFormValidation;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:54

---

CollectionFormRendererOptions

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:23

Extended by

• CollectionFormRendererProps

Indexable

[key: string]: unknown

Properties

disabled?

optional disabled?: boolean;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:25

placeholder?

optional placeholder?: string;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:26

readonly?

optional readonly?: boolean;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:24

relationQuery?

optional relationQuery?: CollectionQuery<CollectionRecord>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:27

---

CollectionFormRendererProps

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:30

Extends

• CollectionFormRendererOptions

Indexable

[key: string]: unknown

Properties

disabled?

optional disabled?: boolean;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:25

Inherited from

CollectionFormRendererOptions.disabled

field

field: CollectionField;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:32

onValueChange

onValueChange: (value) => void;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:33

Parameters

Parameter	Type
value	unknown

Returns

void

placeholder?

optional placeholder?: string;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:26

Inherited from

CollectionFormRendererOptions.placeholder

readonly?

optional readonly?: boolean;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:24

Inherited from

CollectionFormRendererOptions.readonly

relationQuery?

optional relationQuery?: CollectionQuery<CollectionRecord>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:27

Inherited from

CollectionFormRendererOptions.relationQuery

value

value: unknown;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:31

---

CollectionFormValidation

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:10

Properties

schema?

readonly optional schema?: StandardSchemaV1<unknown, unknown>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:12

Standard Schema validation, including Zod refinements and superRefine rules.

semantic?

readonly optional semantic?: (values) => 
  | void
  | readonly CollectionFormValidationIssue[]
  | Promise<
  | void
| readonly CollectionFormValidationIssue[]>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:14

Cross-field or domain validation that may perform asynchronous checks.

Parameters

Parameter	Type
values	CollectionFormValidationValues

Returns

| void | readonly CollectionFormValidationIssue[] | Promise< | void | readonly CollectionFormValidationIssue[]>

---

CollectionFormValidationIssue

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:6

Properties

message

readonly message: string;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:7

path?

readonly optional path?: readonly (string | number)[];

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:8

Type Aliases

CollectionForm

type CollectionForm<TCollections, TName> = InstanceType<typeof CollectionForm>;

Defined in: packages/ui/build/collection-form/collection-form.svelte.d.ts:24

Type Parameters

Type Parameter
TCollections extends CollectionRegistry
TName extends CollectionFormName<TCollections>

---

CollectionFormName

type CollectionFormName<TCollections> = Extract<keyof TCollections, string>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:4

Type Parameters

Type Parameter
TCollections extends CollectionRegistry

---

CollectionFormValidationValues

type CollectionFormValidationValues = Readonly<Record<string, unknown>>;

Defined in: packages/ui/build/collection-form/collection-form.types.d.ts:5

Variables

CollectionForm

const CollectionForm: $$IsomorphicComponent;

Defined in: packages/ui/build/collection-form/collection-form.svelte.d.ts:24

---

getCollectionFormFieldContext

const getCollectionFormFieldContext: () => CollectionFormFieldContext;

Defined in: packages/ui/build/collection-form/collection-form-field.svelte.d.ts:18

Returns

CollectionFormFieldContext