Type Definitions
This section documents the public types that actually belong to @silver-formily/vue, plus the way the Vue package consumes types from sibling packages.
When a type really comes from @silver-formily/core, @silver-formily/path, @silver-formily/validator, or @silver-formily/json-schema, this site keeps only a stable bridge page and links you to the source documentation instead of duplicating the original declaration.
When to import from @silver-formily/vue
- The type directly references Vue
Component, component maps, expression scope values, or recursive render options. - You are describing Vue component props rather than the Core field model itself.
- You need to stay aligned with
SchemaField,RecursionField,ExpressionScope, or other Vue-facing APIs.
Type Map
| Category | Start here | Why |
|---|---|---|
| Field component props | Field | Covers IFieldProps, IFieldFactoryProps, and the Vue-only wrapper types. |
| Path bridge | Path | The Vue package consumes FormPathPattern but does not redefine path semantics. |
| Validator bridge | Validator | Validator aliases remain exported for compatibility, while the full contract lives in validator docs. |
| Schema protocol | Schema | Schema, ISchema, SchemaKey, and all x-* contracts live in the json-schema package. |
Vue-specific types
Field and context types
IProviderProps: props forFormProvider; only exposesform.IFieldProps: extendsCoreFieldProps, addsdecoratorContent, and narrowsvalidatortoSchemaFieldValidator.IFieldFactoryProps: factory-component variant of the same idea.IVoidFieldProps: extendsIVoidFieldFactoryPropswithdecoratorContent.IArrayFieldProps/IObjectFieldProps: aliases ofIFieldPropskept for stable component signatures.IReactiveFieldProps: normalized payload for internal reactive field renderers.
Component mapping and state mapping
VueComponentOptionsWithProps/VueComponentProps<T>: extract props from Vue component types.IComponentMapper<T>: maps one component to another.IStateMapper<Props>: projects field state into component props via an object map or a function.
Schema rendering
SchemaVueComponents: component registry consumed bySchemaField.SchemaExpressionScope: expression scope object.ISchemaFieldVueFactoryOptions: Vue-specific factory options forcreateSchemaField.ISchemaFieldProps: props for theSchemaFieldcomponent.ISchemaMapper/ISchemaFilter: callbacks used while traversing schema nodes.IRecursionFieldProps: props forRecursionField; itsbasePathcomes from the path package.SchemaMarkupValidator: extractedx-validatortype for markup schema.ISchemaMarkupFieldProps: markup schema field contract with Vue component mapping support.ISchemaTypeFieldProps:ISchemaMarkupFieldPropswithouttype, useful for narrower generic inference.IExpressionScopeProps: props forExpressionScope.
Helper generics
ComponentPath<T>: extracts the string keys of a component map.ComponentPropsByPathValue<T, P>: resolves component props from a mapped component key.
Types that are intentionally not duplicated here
- Field and form models such as
Field,GeneralField, andForm: see Core Field docs and Core Form docs. - Path contracts such as
FormPathPattern: see the Path docs. - Validator contracts such as
Validator,MultiValidator, andIValidatorRules: see the Validator docs. - Schema contracts such as
Schema,ISchema, andSchemaKey: see the JSON Schema docs.
Import guidance
ts
import type {
IFieldProps,
IRecursionFieldProps,
ISchemaFieldProps,
SchemaVueComponents,
} from '@silver-formily/vue'If you only need the underlying model types, import from the source package directly:
ts
import type { Form, GeneralField } from '@silver-formily/core'
import type { ISchema } from '@silver-formily/json-schema'
import type { Pattern } from '@silver-formily/path'
import type { Validator } from '@silver-formily/validator'