Skip to content

liveValidate/liveOmit: mark only boolean option as deprecated #4886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 21, 2025
Merged

liveValidate/liveOmit: mark only boolean option as deprecated #4886

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03f551b
liveValidate: mark only boolean option as deprecated
nickgros Nov 21, 2025
5461494
Also liveOmit
nickgros Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions packages/core/src/components/Form.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ import _unset from 'lodash/unset';
import getDefaultRegistry from '../getDefaultRegistry';
import { ADDITIONAL_PROPERTY_KEY_REMOVE, IS_RESET } from './constants';

/** Represents a boolean option that is deprecated.
* @deprecated - In a future major release, this type will be removed
*/
type DeprecatedBooleanOption = boolean;

/** The properties that are passed to the `Form` */
export interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> {
/** The JSON schema object for the form */
Expand Down Expand Up @@ -184,9 +189,9 @@ export interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F e
* is provided, then live validation will be performed when a field that was updated is blurred (as a performance
* optimization).
*
* @deprecated - In a future major release, the `boolean` options for this flag will be removed
* NOTE: In a future major release, the `boolean` options for this flag will be removed
*/
liveValidate?: boolean | 'onChange' | 'onBlur';
liveValidate?: 'onChange' | 'onBlur' | DeprecatedBooleanOption;
/** Flag that describes when live omit will be performed. Live omit happens only when `omitExtraData` is also set to
* to `true` and the form's data is updated by the user.
*
Expand All @@ -195,9 +200,9 @@ export interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F e
* is provided, then live omit will be performed when a field that was updated is blurred (as a performance
* optimization).
*
* @deprecated - In a future major release, the `boolean` options for this flag will be removed
* NOTE: In a future major release, the `boolean` options for this flag will be removed
*/
liveOmit?: boolean | 'onChange' | 'onBlur';
liveOmit?: 'onChange' | 'onBlur' | DeprecatedBooleanOption;
/** If set to true, then extra form data values that are not in any form field will be removed whenever `onSubmit` is
* called. Set to `false` by default.
*/
Expand Down