Skip to content

Commit 568f44a

Browse files
authored
fix(Select): description prop leakage (#882)
1 parent 6a1eb23 commit 568f44a

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

.changeset/tricky-impalas-prove.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@cube-dev/ui-kit": patch
3+
---
4+
5+
Fix leakage of `description` prop to the trigger in Select. Add `triggerDescription` prop.

src/components/fields/Select/Select.docs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ A select allows users to choose a single option from a list of predefined choice
3636
- `true` - Auto tooltip on overflow (shows selected value when truncated)
3737
- `object` - Advanced configuration with optional `auto` property
3838

39-
**description** - Text description displayed within the trigger button. Different from field-level description provided by FieldWrapper.
39+
**triggerDescription** - Text description displayed within the trigger button. Different from field-level description provided by FieldWrapper.
4040

4141
**descriptionPlacement** - Controls how description is positioned: `inline`, `block`, or `auto`.
4242

src/components/fields/Select/Select.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ export interface CubeSelectBaseProps<T>
182182
prefix?: ReactNode;
183183
suffix?: ReactNode;
184184
/** Description text for the trigger. Note: Different from field-level description. */
185-
description?: ReactNode;
185+
triggerDescription?: ReactNode;
186186
descriptionPlacement?: 'inline' | 'block';
187187
/** Keyboard shortcut that triggers the select when pressed */
188188
hotkeys?: string;
@@ -277,7 +277,7 @@ function Select<T extends object>(
277277
overlayStyles,
278278
suffix,
279279
message,
280-
description,
280+
triggerDescription,
281281
descriptionPlacement,
282282
hotkeys,
283283
direction = 'bottom',
@@ -462,7 +462,7 @@ function Select<T extends object>(
462462
<DirectionIcon to={state.isOpen ? 'up' : 'down'} />
463463
)
464464
}
465-
description={description}
465+
description={triggerDescription}
466466
descriptionPlacement={descriptionPlacement}
467467
hotkeys={hotkeys}
468468
tooltip={tooltip}

0 commit comments

Comments
 (0)