Skip to content
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

Jump to bottom

[pickers] Improve onError JSDoc #14492

Merged
merged 2 commits into from
Sep 5, 2024
Merged

[pickers] Improve onError JSDoc #14492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2aea120
[pickers] Improve onError JSDoc
flaviendelangle Sep 5, 2024
69c7142
Review Lukas
flaviendelangle Sep 5, 2024
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/date-field/date-field.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/date-picker/date-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/date-range-picker/date-range-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/date-time-field/date-time-field.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/date-time-picker/date-time-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/date-time-range-picker/date-time-range-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/desktop-date-picker/desktop-date-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...anslations/api-docs/date-pickers/desktop-date-range-picker/desktop-date-range-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...translations/api-docs/date-pickers/desktop-date-time-picker/desktop-date-time-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions .../api-docs/date-pickers/desktop-date-time-range-picker/desktop-date-time-range-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/desktop-time-picker/desktop-time-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/mobile-date-picker/mobile-date-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...translations/api-docs/date-pickers/mobile-date-range-picker/mobile-date-range-picker.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/mobile-date-time-picker/mobile-date-time-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...ns/api-docs/date-pickers/mobile-date-time-range-picker/mobile-date-time-range-picker.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/mobile-time-picker/mobile-time-picker.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...ions/api-docs/date-pickers/multi-input-date-range-field/multi-input-date-range-field.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...ocs/date-pickers/multi-input-date-time-range-field/multi-input-date-time-range-field.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...ions/api-docs/date-pickers/multi-input-time-range-field/multi-input-time-range-field.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...ns/api-docs/date-pickers/single-input-date-range-field/single-input-date-range-field.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...s/date-pickers/single-input-date-time-range-field/single-input-date-time-range-field.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...ns/api-docs/date-pickers/single-input-time-range-field/single-input-time-range-field.json
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/translations/api-docs/date-pickers/static-date-picker/static-date-picker.json
View file
Open in desktop
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