Skip to content

Commit ea47af5

Browse files
committed
clarify framework requirement for framework-specific languages in onClose component
1 parent cc3ff8d commit ea47af5

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

packages/components/docs/API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ Renders a WebSocket onClose event handler for the specified programming language
557557
|------|------|-------------|
558558
| props | <code>Object</code> | Component props. |
559559
| props.language | <code>Language</code> | The programming language for which to generate onClose handler code. |
560-
| props.framework | <code>string</code> | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
560+
| props.framework | <code>string</code> | Framework variant; required for framework-specific languages (e.g., &#x27;quarkus&#x27; for java). |
561561
| props.title | <code>string</code> | The title of the WebSocket server. |
562562

563563

packages/components/src/components/OnClose.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ const resolveCloseConfig = (language, framework = '') => {
7070
*
7171
* @param {Object} props - Component props.
7272
* @param {Language} props.language - The programming language for which to generate onClose handler code.
73-
* @param {string} [props.framework=''] - Optional framework variant (e.g., 'quarkus' for java).
73+
* @param {string} [props.framework=''] - Framework variant; required for framework-specific languages (e.g., 'quarkus' for java).
7474
* @param {string} props.title - The title of the WebSocket server.
7575
*
7676
* @returns {JSX.Element} A Text component containing the onClose handler code for the specified language.

0 commit comments

Comments
 (0)