Skip to content

Commit

Permalink
[pickers] Improve onError JSDoc (mui#14492)
Browse files Browse the repository at this point in the history
  • Loading branch information
flaviendelangle authored and Arthur Balduini committed Sep 30, 2024
1 parent 4912fec commit 266996d
Show file tree
Hide file tree
Showing 65 changed files with 408 additions and 388 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@
},
"onClear": { "description": "Callback fired when the clear button is clicked." },
"onError": {
"description": "Callback fired when the error associated to the current value changes.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onSelectedSectionsChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@
},
"onClear": { "description": "Callback fired when the clear button is clicked." },
"onError": {
"description": "Callback fired when the error associated to the current value changes.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onSelectedSectionsChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onOpen": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@
"description": "Callback fired when the popup requests to be closed. Use in controlled mode (see <code>open</code>)."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onOpen": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@
}
},
"onError": {
"description": "Callback fired when the error associated to the current value changes.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onSelectedSectionsChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@
}
},
"onError": {
"description": "Callback fired when the error associated to the current value changes.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onSelectedSectionsChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@
}
},
"onError": {
"description": "Callback fired when the error associated to the current value changes.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onSelectedSectionsChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@
},
"onClear": { "description": "Callback fired when the clear button is clicked." },
"onError": {
"description": "Callback fired when the error associated to the current value changes.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onSelectedSectionsChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@
},
"onClear": { "description": "Callback fired when the clear button is clicked." },
"onError": {
"description": "Callback fired when the error associated to the current value changes.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onSelectedSectionsChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@
},
"onClear": { "description": "Callback fired when the clear button is clicked." },
"onError": {
"description": "Callback fired when the error associated to the current value changes.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onSelectedSectionsChange": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@
"description": "Callback fired when component requests to be closed. Can be fired when selecting (by default on <code>desktop</code> mode) or clearing a value."
},
"onError": {
"description": "Callback fired when the error associated to the current value changes. If the error has a non-null value, then the <code>TextField</code> will be rendered in <code>error</code> state.",
"description": "Callback fired when the error associated with the current value changes. When a validation error is detected, the <code>error</code> parameter contains a non-null value. This can be used to render an appropriate form error.",
"typeDescriptions": {
"error": "The new error describing why the current value is not valid.",
"value": "The value associated to the error."
"error": "The reason why the current value is not valid.",
"value": "The value associated with the error."
}
},
"onMonthChange": {
Expand Down
Loading

0 comments on commit 266996d

Please sign in to comment.