Merge pull request #261 from josefaidt/260-deprecate-hidelabel-time-picker

fix(TimePickerSelect): deprecate hideLabel to match spec
This commit is contained in:
Eric Liu 2020-09-18 17:02:52 -07:00 committed by GitHub
commit f15df7169f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 4 deletions

View file

@ -36,7 +36,6 @@ export const Default = () => ({
}, },
select: { select: {
disabled: boolean("Disabled (disabled in <TimePickerSelect>)", false), disabled: boolean("Disabled (disabled in <TimePickerSelect>)", false),
hideLabel: boolean("No label (hideLabel in <TimePickerSelect>)", true),
labelText: text( labelText: text(
"Label text (labelText in <TimePickerSelect>)", "Label text (labelText in <TimePickerSelect>)",
"Please select" "Please select"

View file

@ -24,10 +24,11 @@
export let labelText = ""; export let labelText = "";
/** /**
* Set to `true` to visually hide the label text * @deprecated The `hideLabel` prop for `TimePickerSelect` is no longer needed and has been deprecated. It will be removed in the next major release.
* @type {boolean} [hideLabel=false] * Set to `false` to show the label text
* @type {boolean} [hideLabel=true]
*/ */
export let hideLabel = false; export let hideLabel = true;
/** /**
* Set an id for the select element * Set an id for the select element
@ -72,6 +73,7 @@
for="{id}" for="{id}"
class:bx--label="{true}" class:bx--label="{true}"
class:bx--visually-hidden="{hideLabel}"> class:bx--visually-hidden="{hideLabel}">
<!-- TODO: set to always be `true` after `hideLabel` is deprecated -->
{labelText} {labelText}
</label> </label>
{/if} {/if}