You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/docs/docs/api-reference/utility-functions.md
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -899,7 +899,7 @@ Returns the superset of `formData` that includes the given set updated to includ
899
899
-[rootSchema]: S | undefined - The root schema, used to primarily to look up `$ref`s
900
900
-[includeUndefinedValues=false]: boolean | "excludeObjectChildren" - Optional flag, if true, cause undefined values to be added as defaults. If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as false when computing defaults for any nested object properties.
901
901
-[experimental_defaultFormStateBehavior]: Experimental_DefaultFormStateBehavior - See `Form` documentation for the [experimental_defaultFormStateBehavior](./form-props.md#experimental_defaultFormStateBehavior) prop
902
-
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_customMergeAllOf) prop
902
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
903
903
904
904
#### Returns
905
905
@@ -916,6 +916,7 @@ Determines whether the combination of `schema` and `uiSchema` properties indicat
916
916
-[uiSchema={}]: UiSchema<T, S, F> - The UI schema from which to derive potentially displayable information
917
917
-[rootSchema]: S | undefined - The root schema, used to primarily to look up `$ref`s
918
918
-[globalOptions={}]: GlobalUISchemaOptions - The optional Global UI Schema from which to get any fallback `xxx` options
919
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
919
920
920
921
#### Returns
921
922
@@ -936,6 +937,7 @@ The closest match is determined using the number of matching properties, and mor
936
937
- options: S[] - The list of options to find a matching options from
937
938
-[selectedOption=-1]: number - The index of the currently selected option, defaulted to -1 if not specified
938
939
-[discriminatorField]: string | undefined - The optional name of the field within the options object whose value is used to determine which option is selected
940
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
939
941
940
942
#### Returns
941
943
@@ -985,6 +987,7 @@ Checks to see if the `schema` and `uiSchema` combination represents an array of
985
987
- schema: S - The schema for which check for array of files flag is desired
986
988
-[uiSchema={}]: UiSchema<T, S, F> - The UI schema from which to check the widget
987
989
-[rootSchema]: S | undefined - The root schema, used to primarily to look up `$ref`s
990
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
988
991
989
992
#### Returns
990
993
@@ -999,6 +1002,7 @@ Checks to see if the `schema` combination represents a multi-select
999
1002
- validator: ValidatorType<T, S, F> - An implementation of the `ValidatorType` interface that will be used when necessary
1000
1003
- schema: S - The schema for which check for a multi-select flag is desired
1001
1004
-[rootSchema]: S | undefined - The root schema, used to primarily to look up `$ref`s
1005
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
1002
1006
1003
1007
#### Returns
1004
1008
@@ -1013,6 +1017,7 @@ Checks to see if the `schema` combination represents a select
1013
1017
- validator: ValidatorType<T, S, F> - An implementation of the `ValidatorType` interface that will be used when necessary
1014
1018
- theSchema: S - The schema for which check for a select flag is desired
1015
1019
-[rootSchema]: S | undefined - The root schema, used to primarily to look up `$ref`s
1020
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
- schema: S - The schema for which retrieving a schema is desired
1049
1054
-[rootSchema={}]: S - The root schema that will be forwarded to all the APIs
1050
1055
-[rawFormData]: T | undefined - The current formData, if any, to assist retrieving a schema
1056
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
1051
1057
1052
1058
#### Returns
1053
1059
@@ -1067,6 +1073,7 @@ Also, any properties in the old schema that are non-existent in the new schema a
1067
1073
-[newSchema]: S | undefined - The new schema for which the data is being sanitized
1068
1074
-[oldSchema]: S | undefined - The old schema from which the data originated
1069
1075
-[data={}]: any - The form data associated with the schema, defaulting to an empty object when undefined
1076
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
1070
1077
1071
1078
#### Returns
1072
1079
@@ -1085,6 +1092,7 @@ Generates an `IdSchema` object for the `schema`, recursively
1085
1092
-[formData]: T | undefined - The current formData, if any, to assist retrieving a schema
1086
1093
-[idPrefix='root']: string - The prefix to use for the id
1087
1094
-[idSeparator='_']: string - The separator to use for the path segments in the id
1095
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
1088
1096
1089
1097
#### Returns
1090
1098
@@ -1101,6 +1109,7 @@ Generates an `PathSchema` object for the `schema`, recursively
1101
1109
-[name='']: string - The base name for the schema
1102
1110
-[rootSchema]: S | undefined - The root schema, used to primarily to look up `$ref`s
1103
1111
-[formData]: T | undefined - The current formData, if any, to assist retrieving a schema
1112
+
-[experimental_customMergeAllOf]: Experimental_CustomMergeAllOf<S> - See `Form` documentation for the [experimental_customMergeAllOf](./form-props.md#experimental_custommergeallof) prop
0 commit comments