Skip to content

Commit 1b1b76e

Browse files
authored
chore: unmark description as deprecated for inputs (#4205)
## Description unmark `description` as deprecated for inputs _Screenshot_ If relevant, add a screenshot or two of the changes you made. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Un-deprecates and documents `description` on `Input` types and publishes patch releases across SDK packages. > > - **Types**: > - `Input` interface: un-deprecate and document `description` in `packages/core/src/builder.class.ts` and `packages/sdks/src/types/input.ts`. > - **Releases**: > - Patch version bumps for `@builder.io/sdk`, `@builder.io/react`, and all framework SDKs listed in `.changeset/lucky-rockets-rule.md`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 417307e. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent e35fdb8 commit 1b1b76e

File tree

3 files changed

+16
-2
lines changed

3 files changed

+16
-2
lines changed

.changeset/lucky-rockets-rule.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
"@builder.io/sdk": patch
3+
"@builder.io/react": patch
4+
"@builder.io/sdk-angular": patch
5+
"@builder.io/sdk-react-nextjs": patch
6+
"@builder.io/sdk-qwik": patch
7+
"@builder.io/sdk-react": patch
8+
"@builder.io/sdk-react-native": patch
9+
"@builder.io/sdk-solid": patch
10+
"@builder.io/sdk-svelte": patch
11+
"@builder.io/sdk-vue": patch
12+
---
13+
14+
chore: add back `description` support for inputs

packages/core/src/builder.class.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@ export interface Input {
532532
name: string;
533533
/** A friendlier name to show in the UI if the component prop name is not ideal for end users */
534534
friendlyName?: string;
535-
/** @hidden @deprecated */
535+
/** A description to show in the UI to give guidance on how to use this input */
536536
description?: string;
537537
/** A default value to use */
538538
defaultValue?: any;

packages/sdks/src/types/input.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export interface Input {
33
name: string;
44
/** A friendlier name to show in the UI if the component prop name is not ideal for end users */
55
friendlyName?: string;
6-
/** @hidden @deprecated */
6+
/** A description to show in the UI to give guidance on how to use this input */
77
description?: string;
88
/** A default value to use */
99
defaultValue?: any;

0 commit comments

Comments
 (0)