Skip to content

Commit 0c18bdc

Browse files
committed
fix: change jsdoc to allow the web-component-analyzer to output correct information
1 parent 11c75a5 commit 0c18bdc

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

packages/uui-color-swatch/lib/uui-color-swatch.element.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,13 +191,13 @@ export class UUIColorSwatchElement extends LabelMixin(
191191
];
192192

193193
private _value: string | undefined = '';
194+
194195
/**
195196
* Value of the swatch. Should be a valid hex, hexa, rgb, rgba, hsl or hsla string. Should fulfill this [css spec](https://www.w3.org/TR/css-color-4/#color-type). If not provided element will look at its text content.
196-
* @type { string }
197+
*
197198
* @attr
198-
* @default ""
199199
*/
200-
@property({ type: String })
200+
@property()
201201
get value(): string {
202202
return this._value ? this._value : this.textContent?.trim() || '';
203203
}
@@ -210,24 +210,23 @@ export class UUIColorSwatchElement extends LabelMixin(
210210

211211
/**
212212
* Determines if the options is disabled. If true the option can't be selected
213-
* @type { boolean }
213+
*
214214
* @attr
215-
* @default false
216215
*/
217216
@property({ type: Boolean, reflect: true })
218217
disabled = false;
219218

220219
/**
221220
* When true shows element label below the color checkbox
222221
*
222+
* @attr
223223
* @memberof UUIColorSwatchElement
224224
*/
225225
@property({ type: Boolean, attribute: 'show-label' })
226226
showLabel = false;
227227
/**
228228
* Colord object instance based on the value provided to the element. If the value is not a valid color, it falls back to black (like Amy Winehouse). For more information about Colord, see [Colord](https://omgovich.github.io/colord/)
229229
*
230-
* @type {(Colord | null)}
231230
* @memberof UUIColorSwatchElement
232231
*/
233232
get color(): Colord | null {

packages/uui-color-swatches/lib/uui-color-swatches.element.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,8 @@ export class UUIColorSwatchesElement extends LabelMixin('label', LitElement) {
2929

3030
/**
3131
* Value of selected option.
32-
* @type { string }
32+
*
3333
* @attr
34-
* @default ""
3534
*/
3635
@property()
3736
value = '';

0 commit comments

Comments
 (0)