Skip to content
svelte-jsonschema-form v3
Playground Form Builder

@sjsf/form

@sjsf/form

3.0.0-next.12

Major Changes

    • Remove form.value property (#221)
    • Remove getSnapshot form option
    • Add setValue, getValueSnapshot form methods
    • Use ValidationResult<Output> as the return type for validateFormValue and validateFormValueAsync methods

  • Introduce FormValidator type (#222)

3.0.0-next.11

3.0.0-next.10

Major Changes

    • Reuse merger options definition in getDefaultFieldState parameters (b5a5c86)
    • Move includeUndefinedValues option from merger instance to mergeFormDataAndSchemaDefaults method options

Patch Changes

  • Disable clear and clearEdit action buttons for read-only fields and disabled forms (c303125)

  • Fix oneOf/anyOf fields (ed0a797)

3.0.0-next.9

Major Changes

  • Add field actions support (#216)

    • Add fields/extra/* submodule (#216)
    • Remove the template suffix from component names in the templates/* submodule
    • Replace the fields/resolver submodule with the theme submodule

  • Distinguish between missing and undefined values in ui:options (#216)

3.0.0-next.8

Major Changes

  • Turn create* form methods into queries (#215)

  • Turn validate and validateAsync methods into queries (#215)

  • Use more fine-grained type augmentation (#215)

3.0.0-next.7

Major Changes

  • Rename isObjectProto to isRecordProto (#213)

  • Make event optional for form.reset method (#213)

  • Port https://github.com/rjsf-team/react-jsonschema-form/pull/4490 (#211)

  • Add schema consistency checks during merge (#211)

    • Change signature of getSchemaDefinitionByPath (#213)
    • Remove getRootSchemaTitleByPath function
    • Change valueRef type in Field component from { value: FieldValue } to Ref<FieldValue>

  • Refactor translation types (#213)

  • Separate state related functions into queries and commands (#211)

Minor Changes

  • Add assert adapters for extra fields (#211)

  • Add aria helpers functions (#214)

  • Add HiddenIdPrefixInput form component (#213)

Patch Changes

  • Fix generation of default value for additional property (#211)

  • Fix handling of dependencies and if,then,else keywords in getSchemaDefinitionByPath function (#213)

  • Fix combination field logic (#211)

  • Make combination field SRR friendly (#211)

  • Fix deduplication in intersection algorithms (#211)

3.0.0-next.6

Patch Changes

  • Remove tracking when calling updateErrors (b735108)

3.0.0-next.5

Major Changes

    • Added a required path property to the Config type (#207)
    • Updated the JsonPaths type to return a union of Paths
    • Replaced the name prop with path in the Field component

  • Remove generic validator parameter (#207)

    • Added a new required createForm parameter: createIdBuilder (#205)
    • Removed the idSeparator and idPseudoSeparator parameters
    • Removed the following types:
      • IdPrefixOption
      • IdSeparatorOption
      • IdPseudoSeparator
      • IdOptions
      • PathToIdOptions
    • focus-on-first-error module changes:
      • Updated signatures of getErrorsList and getFocusAction
      • Removed the GetFocusActionOptions type
    • Replace id property with path in Config type (#209)
    • Remove from.errors property
    • Remove form errors bindable option
    • Replace idFromPath with createId function
    • Replace createChildId with createChildPath function
    • Replace getErrors with getFieldErrors function
    • Add updateErrors, hasErrors, getErrors functions

  • Remove create prefix from creatable form options (#208)

  • Change the error type to simple string (#207)

  • Replace the validate and validateAsync form methods with separate functions (#209)

Minor Changes

  • Allow to return update callback from form validator methods (#207)

3.0.0-next.4

Patch Changes

  • Fix field state cleanup (ca11ecb)

3.0.0-next.3

Patch Changes

3.0.0-next.2

Major Changes

  • Bump minimal svelte version to 5.39.0 (#202)

  • Add support for nullable schemas (#202)

  • Refactor standard schema validator factory signature (#202)

    • The makeEventHandlers function signature has been updated (181c3ce)
    • Added the hasFieldState function to check a field’s state
    • The isSubmitted and isChanged properties are now readonly
    • isSubmitted is reset after successful processing (validation + onSubmit handler)
    • isChanged becomes true after any interaction before the form is submitted or reset

  • Make itemValue parameter of ItemTitle function required (#202)

  • Extract handlers application into handlersAttachment helper (#202)

  • Remove @sjsf/form/extra-fields/date-field extra field definition (3c90ec2)

  • Remove validate method form ObjectContext and ArrayContext interfaces (3ac49c9)

Minor Changes

  • Export createArrayComparator and ascComparator functions (#202)

  • Add and implement collectErrors UI option for tags field (#202)

  • Add aggregatedField field and aggregatedWidget widget definition (3100b4d)

Patch Changes

3.0.0-next.1

Major Changes

  • Add unknown schema type (#200)

Minor Changes

  • Allow to extend SchemaValue type (#200)

  • Add AsyncFileListValidator validator (#200)

  • Add node.js support for lib/file (#200)

  • Add nativeFile* fields (#200)

  • Add validators/file-size validator (#200)

Patch Changes

  • Fix changes propagation in keyed array (b649510)

3.0.0-next.0

Major Changes

    • Add mergeSchemas method to the Merger interface (#177)
    • Update resolveAllReferences and related functions to accept a Merger instance for schema merging
    • Make merger form option required

  • Refactor array field context to make it extendable (#198)

  • Refactor KeyedArray interface (#198)

  • Refactor object field context to make it extendable (#198)

  • Add length, set and validate methods to ArrayContext interface (#198)

  • Replace validator and merger with required createValidator and createMerger options. (#177) Consider all options as reactive.

  • Remove deprecated code (#196)

  • Replace FormInternalContext with FormState (#197)

Minor Changes

  • Add validate and validateAsync form methods (#198)

  • Add createValidator and createMerger form options for convenient use as defaults values. (#177) Add errors option for creating controlled forms. Rename formHandlers to handlers.

2.4.0

Minor Changes

  • Add Ref and Bind types (#190)

  • Export mergers from form/mergers (#191)

  • Add json-schema, math, ord, traverser libs, new array functions (#191)

2.3.0

Minor Changes

  • Pass item value to itemTitle function (#178)

  • Add keyedArraysMap form option (#180)

  • Add keyedArray option to createArrayContext, createTupleContext functions. (#182)

Patch Changes

2.2.4

Patch Changes

  • Revert “[form] Preserve array keys by injecting default values instead of state replacing” (bab9bce)

2.2.3

Patch Changes

  • Fix omitting dependency arrays in the schema transformer (8be9383)

  • Preserve array keys by injecting default values instead of state replacing (#170)

2.2.2

2.2.1

Patch Changes

2.2.0

Minor Changes

  • Add value option (#158)

  • Add a task.svelte submodule to replace action.svelte (3488450)

Patch Changes

  • Migrate to task.svelte lib (803d56d)

2.1.2

Patch Changes

  • Clarify the empty field name warning in the Field component (35afc7b)

  • Fix display of custom enum names in booleanSelectField (f2f1cbc)

2.1.1

2.1.0

2.0.2

Patch Changes

2.0.1

Patch Changes

  • Deprecate children prop in Field component (d3c05fe)

  • Fixed Field component template (935d414)

2.0.0

Major Changes

  • Add support for $ref in UI schema (#100)

  • Add label component (b215668)

  • Remove lib/deep-equal submodule (3f780ca)

  • Add useLabel property for the fieldTemplate component (e8eaae3)

  • Extract array field logic into createArrayContext function (99b77fb)

  • Remove forId from the errorList component props (f6588ff)

  • Remove uiOptions property from Config (#100)

  • Bump peer and dev dependencies (21e47cc)

  • Rename fields/extra-widgets/file-widget to fields/extra-widgets/file (d75d847)

  • Remove name property from Config (1da5c84)

  • Make checkboxes and file widgets optional (8fa706b)

  • Replace asyncProxy with createAsyncBinding (#119)

  • Refactor action logic: (8606f26)

    • Remove debounce combinator
    • Add untrack combinator result

  • The DefaultFormMerger class has been replaced by the createFormMerger factory. (43c86da)

  • Update initialValue type in FormOptions to be Partial<T> (#135)

  • Rename FoundationalComponent to FoundationalComponentType (9ca2d7f)

  • Relax component compatibility checks. (cb176ac) Add a type discriminator for field, template, and widget properties. Remove Equal and ExpandAndEqual types from lib/types

  • Remove use-mutation submodule (c616f00)

  • Remove proxy function from lib/svelte.svelte (1138f61)

  • Migrate to resolver based providers (dfd96e7)

  • Bump svelte to 5.25.0, relax patch versions of peer dependencies. (33fcab1)

  • Refactor form API: (daabc32)

    • Renames:
      • form.validation -> form.submission
      • validationCombinator -> submissionCombinator
      • validationDelayedMs -> submissionDelayedMs
      • validationTimeoutMs -> submissionTimeoutMs
    • form.submit now returns void

  • Add support for extra attributes in input, textarea, and select attribute functions (ef7ea00)

  • Move checkboxes and file widgets to extra folder (701c3fc)

  • Remove the UI options submitButtonText and additionalPropertyKeyPrefix in favor of the new translations option. (f30da6d)

  • Fix https://github.com/x0k/svelte-jsonschema-form/issues/103 (1c75328)

    Renames in the following submodules:

    • @sjsf/form/fields/array/*
    • @sjsf/form/fields/object/*
    • @sjsf/form/templates/*

  • Remove legacy-omit-extra-data submodule (3c865f3)

  • Refactor action logic: (d958dfc)

    • run methods now returns void
    • Added runAsync method that returns Promise<R>
    • Fixed state_referenced_locally warning

  • Remove asSnippet function (a9dc859)

  • Rename FormTag to Form (#100)

  • Rename setFromContext to setFormContext (e9a861b)

  • Remove UiSchemaRootContent type (49e4b89)

  • Extract object field logic into createObjectContext function (73ee1fb)

  • Add support for patternProperties keyword (162b001)

  • Rename submodule prevent-data-loss to prevent-page-reload (1ae4972)

  • Replace action Status enum with string literals (5e85a87)

  • Remove validate and validateAsync form state methods (#130)

  • Remove AnyKey type (d569453)

  • Migrate to a new Validator type model (dfd96e7)

  • Remove required and forId from the title component props (52676ca)

  • Remove getValueByPath function (1516c2d)

Minor Changes

  • Add fromFactories function to lib/resolver (61b8dab)

  • Add tagsField extra field and tagsWidget extra widget definition (cff3574)

  • Add env lib (#71)

  • Add combobox widget type (4abf5d6)

  • The getValueByPath function has been returned. (f37bf4a)

  • Add css lib (#71)

  • Add extraUiOptions property to form options (1a552e8)

  • Pass widgetType property to the fieldTemplate component (749a333)

  • Add useDatePickerForDateFormat function to fields/extra-widgets/date-picker (768f8c2)

  • Use untrack inside the following Action methods: run, runAsync, and abort. (5206095)

  • Export JsonPaths type form @sjsf/form/lib/types (#135)

  • Add getSchemaDefinitionByPath function (eb9ad24)

  • Add validators/precompile submodule (9882dd8)

  • Add Field component (#135)

  • Add lib/component submodule (#100)

  • Add matches method to Action for type narrowing (f626bd8)

  • Add arraySubSchemasMergeType option for mergeSchemas function (b2c896b)

  • Add getUiSchemaByPath function (283d6de)

  • Add resolver lib (d5c93c3)

  • Add options parameter to createFormMerger factory (0bcf9c6)

  • Add support for discriminator schema property (f6fd57c)

  • Add standard schema form value validator (c43eb93)

  • Add registry form option (#100)

  • Add function getRootSchemaTitleByPath (84f9ff9)

Patch Changes

2.0.0-next.15

Major Changes

  • Bump peer and dev dependencies (21e47cc)

  • Replace asyncProxy with createAsyncBinding (#119)

Patch Changes

2.0.0-next.14

2.0.0-next.13

2.0.0-next.12

Major Changes

Patch Changes

2.0.0-next.11

Major Changes

  • Add support for patternProperties keyword (162b001)

Minor Changes

  • Add support for discriminator schema property (f6fd57c)

2.0.0-next.10

Major Changes

  • Add support for $ref in UI schema (#100)

  • Remove uiOptions property from Config (#100)

  • Rename FormTag to Form (#100)

Minor Changes

  • Add lib/component submodule (#100)

  • Add registry form option (#100)

Patch Changes

2.0.0-next.9

Major Changes

  • Extract array field logic into createArrayContext function (99b77fb)

  • Extract object field logic into createObjectContext function (73ee1fb)

Minor Changes

  • Add validators/precompile submodule (9882dd8)

  • Add arraySubSchemasMergeType option for mergeSchemas function (b2c896b)

2.0.0-next.8

Major Changes

  • Rename fields/extra-widgets/file-widget to fields/extra-widgets/file (d75d847)

  • Rename FoundationalComponent to FoundationalComponentType (9ca2d7f)

  • Relax component compatibility checks. (cb176ac) Add a type discriminator for field, template, and widget properties. Remove Equal and ExpandAndEqual types from lib/types

  • Add support for extra attributes in input, textarea, and select attribute functions (ef7ea00)

  • Remove UiSchemaRootContent type (49e4b89)

Minor Changes

  • Add fromFactories function to lib/resolver (61b8dab)

  • Add tagsField extra field and tagsWidget extra widget definition (cff3574)

  • Add extraUiOptions property to form options (1a552e8)

  • Add useDatePickerForDateFormat function to fields/extra-widgets/date-picker (768f8c2)

2.0.0-next.7

Major Changes

  • Add label component (b215668)

  • Add useLabel property for the fieldTemplate component (e8eaae3)

  • Remove forId from the errorList component props (f6588ff)

  • Remove proxy function from lib/svelte.svelte (1138f61)

  • Remove required and forId from the title component props (52676ca)

Minor Changes

  • Pass widgetType property to the fieldTemplate component (749a333)

Patch Changes

2.0.0-next.6

Patch Changes

  • Fixed enumField recognition in compat resolver (6f4942b)

2.0.0-next.5

Major Changes

  • Bump svelte to 5.25.0, relax patch versions of peer dependencies. (33fcab1)

Patch Changes

  • Refactor matching logic to improve validation performance and accuracy (69535c3)

2.0.0-next.4

Minor Changes

  • The getValueByPath function has been returned. (f37bf4a)

  • Add standard schema form value validator (c43eb93)

  • Add function getRootSchemaTitleByPath (84f9ff9)

2.0.0-next.3

Major Changes

  • The DefaultFormMerger class has been replaced by the createFormMerger factory. (#83)

  • Remove AnyKey type (#83)

  • Remove getValueByPath function (#83)

Minor Changes

  • Add getSchemaDefinitionByPath function (#83)

  • Add getUiSchemaByPath function (#83)

  • Add options parameter to createFormMerger factory (0bcf9c6)

2.0.0-next.2

2.0.0-next.1

Major Changes

  • Make checkboxes and file widgets optional (#81)

  • Move checkboxes and file widgets to extra folder (#81)

Patch Changes

  • Fix theme resolver type (#81)

  • Fix type of fields resolver (#81)

2.0.0-next.0

Major Changes

  • Remove lib/deep-equal submodule (#78)

  • Remove use-mutation submodule (#78)

  • Migrate to resolver based providers (#78)

  • Remove legacy-omit-extra-data submodule (#78)

  • Remove asSnippet function (#78)

  • Rename submodule prevent-data-loss to prevent-page-reload (#78)

  • Migrate to a new Validator type model (#78)

Minor Changes

  • Add env lib (#71)

  • Add css lib (#71)

  • Add resolver lib (#78)

1.9.2

Patch Changes

1.9.1

Patch Changes

  • Use keyed array inside an array field to preserve items state (#65)

1.9.0

Minor Changes

  • Add omit extra data submodule (#56)

  • Add create action submodule (#61)

  • Add fake-validator submodule (#60)

  • Add FormElement, RawForm, Form2 components (#60)

Patch Changes

1.8.0

Minor Changes

  • Add isSchemaValueDeepEqual and isSchemaDeepEqual functions (#55)

  • Add createForm3 function (#54)

    Migration

    • Replace useForm2 with createForm3.
    • If custom form is used it should call setFormContext(form.context) before using FormContent and SubmitButton components.

Patch Changes

  • Extract array and object fields logic into their contexts (#50)

  • Bump dev deps (a7dd2ce)

1.7.0

Minor Changes

Patch Changes

  • Fix array based inputs validation (#40)

  • Do not consider const in readonly attribute calculation. (#34)

1.6.1

Patch Changes

1.6.0

Minor Changes

  • Add parent property to the SchemaTraverserContext (#28)

  • Add additional property key validator (#28)

1.5.1

Patch Changes

  • d8b4211 Thanks @x0k! - Fix multi-field selector

    This is not a proper fix (array of multi-fields is still broken) but it’s a good place to start.

1.5.0

Minor Changes

  • #26 c75aa31 Thanks @x0k! - Add preventDataLoss function for handling beforeunload event

  • #26 dad20e1 Thanks @x0k! - Allow to pass multiple arguments to mutation.run method

  • #26 a6606d1 Thanks @x0k! - Add form option pseudoIdSeparator

Patch Changes

  • #26 34b2481 Thanks @x0k! - Changed the value of DEFAULT_ID_SEPARATOR

    This change may be a BREAKING change for you if you code implicitly depends on this constant.

  • #26 89a3e04 Thanks @x0k! - Remove forced undefined for value in onSubmit handler of the form

  • #26 0084022 Thanks @x0k! - Allow to pass a Map and Array to the initialErrors form option

1.4.0

Minor Changes

  • 56a406a Thanks @x0k! - Add isChanged property to the from state

  • 5ac9c3f Thanks @x0k! - Add updateErrorsByPath method to the FormState

  • d0d7d36 Thanks @x0k! - Add submit and reset methods to the FormState

  • #24 aed9889 Thanks @x0k! - Add useMutation API

1.3.0

Minor Changes

  • fe35ad2 Thanks @x0k! - Reset form value in default reset handler

  • #22 6144b9a Thanks @x0k! - Implement useForm API, Add FormContent and SubmitButton components

  • 13a1beb Thanks @x0k! - Add createForm function

  • e2c9d61 Thanks @x0k! - Allow to augment InputAttributes type

Patch Changes

1.2.0

Patch Changes

  • c80ec86 Thanks @x0k! - Fix reading title from undefined schema

  • 41980fd Thanks @x0k! - Sync dev packages versions

1.1.2

Patch Changes

  • 4f8c576 Thanks @x0k! - Fix defaults population for properties from dependencies

1.1.1

Patch Changes

1.1.0

Minor Changes

  • 67ff48c Thanks @x0k! - Add merger form option

  • 26a1f69 Thanks @x0k! - Add mergeFormDataAndSchemaDefaults method to Merger

Patch Changes

1.0.0

Major Changes

0.2.7

Patch Changes

0.2.6

Patch Changes

  • 607a3c3 Thanks @x0k! - Fix duplication of form field id in widgets with options list

  • 63293f8 Thanks @x0k! - Add getSnapshot property

0.2.5

Patch Changes

0.2.4

Patch Changes

0.2.3

0.2.2

Patch Changes

  • 0a4bad3 Thanks @x0k! - Add FormBase, getDefaultFormState exports

0.2.1

Patch Changes

  • 2003fcd Thanks @x0k! - Add icons property

  • b89983a Thanks @x0k! - Remove label for range widget

  • 2dd6c35 Thanks @x0k! - Disable copy button for fixed elements of array

  • da81bf8 Thanks @x0k! - Fix root-field layout gap

  • 339f9be Thanks @x0k! - Fix object property title evaluation

0.2.0

Minor Changes

  • d36a76c Thanks @x0k! - Remove form readonly attribute (use inert instead)

0.1.0

Minor Changes

  • ea62b7c Thanks @x0k! - Make default behavior of the form the same as native form

  • 3ce6404 Thanks @x0k! - Implement inputs validation feature

0.0.6

Patch Changes

  • c0cba76 Thanks @x0k! - Update options mapping, for custom mappers

0.0.5

Patch Changes

0.0.4

Patch Changes

  • 8c337bb Thanks @x0k! - Remove scheduler-polyfill due SSR errors

  • ae990a7 Thanks @x0k! - Move options mapping helpers to form package

  • f910d77 Thanks @x0k! - Add publint

  • 7d0cd8a Thanks @x0k! - Move datalist creation logic to form fields

0.0.3

Patch Changes

  • 6393f13 Thanks @x0k! - Remove tests files from bundle

  • 37c116b Thanks @x0k! - Remove unsupported fields, alert component

0.0.2

Patch Changes

  • f84af68 Thanks @x0k! - Update metainformation and release configs