feat(label): deprecate status prop #3984

y0n4 · 2022-01-22T00:28:53Z

Related Issue: #3755

Summary

Originally user can set status indirectly by declaring status prop in calcite-input

<calcite-label status="invalid">
  <calcite-input></calcite-input>
  <calcite-input-message>Invalid</calcite-input-message>
</calcite-label>

However it is not ideal so to set status in calcite-input and calcite-input-message, the prop must be declared directly within those components. The status in calcite-label will be deprecated.

<calcite-label>
  <calcite-input status="invalid"></calcite-input>
  <calcite-input-message status="invalid">Invalid</calcite-input-message>
</calcite-label>

driskull

@y0n4 what about removing or deprecating the status property on the label?

Would this be a breaking change if we remove the getElementProp support on the inputs?

…atus prop for calcite-label

…t/input-message

… slots. (#3962) * refactor(panel, shell, tree-item): Add keys to conditionally rendered slots. * add const for key. * fix code * review cleanup

Co-authored-by: jcfranco <jcfranco@users.noreply.github.com>

…3889) * refactor: Update relevant components to use ConditionalSlotComponent #3686 * cleanup * cleanup * cleanup * fix links that aren't direct slots * remove assigned slot check, only get direct children * fix test * cleanup * cleanup * partial review fixes * revert changes to combobox and card

…ed (#3969) * refactor(slider): remove eventListeners on DOM disconnected * feedback changes * add private method for duplicate code * rename method

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

…ame time most recently pressed key takes over (#3989) Co-authored-by: Eliza Khachatryan <eli97736@esri.com>

…/3755-input-status

src/components/calcite-input/calcite-input.e2e.ts

src/components/calcite-label/calcite-label.tsx

…/3755-input-status

…4/3755-input-status

jcfranco

Sorry for not catching this sooner, but since we are deprecating the label prop, we should still have it work. We will just have the examples and doc not promote the deprecated way. That means this will no longer be a breaking change, so no need for the ! in the PR title nor the BREAKING CHANGES footer when merging.

So, can you do the following?

Restore the input and message (not label) e2e tests and update the test name with a (deprecated) or add a comment to the assertions (if the test title isn't specific to status) to indicate that it is deprecated.
Restore the this.status = getElementProp(this.el, "status", this.status); lines.

I'll approve after these changes are made.

driskull · 2022-01-27T01:36:12Z

Thanks for chiming in! I wasn't sure if we wanted to deprecate or if we were ok removing it and allowing a breaking change.

I guess the issue should have clarified a deprecation instead of removal.

* docs(templates): provide content for the repro samples * use cc latest version Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…l code is not found (#3968) * fix(date-picker): update utils locale to get the lang code if regional code is not found * alter util changes based from pr comments

* ci: allow primary and secondary contacts to merge on all prs * cleanup * use admin token

…ion files (#3980) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix(tree): enable multi select with pointer * save selected items at main level * fix single selection mode * deselect siblings when mode is single * fix deselecting tree item when mode is multi * fix deselecting with shift keydown * refactor e2e test * remove unused imports in e2e * feedback changes * emit calciteTreeSelect event without shift key * refactor code * add e2e test and feedback changes Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* test(dropdown): correct logical errors in the test * assert both events after each toggle action and use page.waitForEvent before doing assertions Co-authored-by: Eliza Khachatryan <eli97736@esri.com>

…onents into y0n4/3755-input-status

jcfranco

👍🏼

I renamed the PR title according to this thread.

jcfranco · 2022-01-27T23:01:41Z

src/components/calcite-input-message/calcite-input-message.e2e.ts

@@ -37,8 +37,8 @@ describe("calcite-input-message", () => {
    </calcite-label>
    `);

-    const element = await page.find("calcite-input-message");
-    expect(element).toEqualAttribute("status", "invalid");
+    const deprecatedLabelStatusElement = await page.find("calcite-input-message");


jcfranco · 2022-01-27T23:14:17Z

src/components/calcite-label/calcite-label.tsx

-  /** specify the status of the label and any child input / input messages */
+  /**
+   * specify the status of the label and any child input / input messages
+   * @deprecated set directly on child element instead


+@benelan for editorial glance. 👀

Looks good, thanks for changing it Yona!

Although the prop description is kinda confusing to me (I'll do an audit at some point before v1) but that was already there lol. The new deprecation notice is 👨‍🍳 👌

…/3755-input-status

y0n4 requested a review from a team as a code owner January 22, 2022 00:28

github-actions bot added this to the Sprint 01/17 - 01/28 milestone Jan 22, 2022

github-actions bot assigned y0n4 Jan 22, 2022

github-actions bot added the bug Bug reports for broken functionality. Issues should include a reproduction of the bug. label Jan 22, 2022

driskull reviewed Jan 24, 2022

View reviewed changes

y0n4 changed the title ~~fix(input, input-message): remove getElementProp for status and change verbiage on readme~~ BREAKING CHANGE(input, input-message): remove getElementProp for status and change verbiage on readme Jan 24, 2022

benelan changed the title ~~BREAKING CHANGE(input, input-message): remove getElementProp for status and change verbiage on readme~~ fix(input, input-message)!: remove getElementProp for status and change verbiage on readme Jan 24, 2022

y0n4 changed the title ~~fix(input, input-message)!: remove getElementProp for status and change verbiage on readme~~ fix(input, input-message)!: deprecate and no longer support status prop for calcite-label Jan 24, 2022

y0n4 changed the title ~~fix(input, input-message)!: deprecate and no longer support status prop for calcite-label~~ fix(label, input, input-message)!: deprecate and no longer support status prop for calcite-label Jan 24, 2022

Yona Nagayama and others added 15 commits January 24, 2022 11:26

fix(label, input, input-message)!: deprecate and no longer support st…

9fabc75

…atus prop for calcite-label

alter tests for status being passed in calcite label

a771d5c

update the readme for labels using status and add status prop to inpu…

37716bd

…t/input-message

add deprecated comment for status prop

a2738e4

refactor(panel, shell, tree-item): Add keys to conditionally rendered…

e59ccc7

… slots. (#3962) * refactor(panel, shell, tree-item): Add keys to conditionally rendered slots. * add const for key. * fix code * review cleanup

feat(panel): Add method to scroll content. #3924 (#3960)

fd14009

ci(screener): updating to Chrome 97 (#3940)

a9d4750

1.0.0-next.373

dae25ab

docs: update component READMEs (#3972)

32bbf5f

Co-authored-by: jcfranco <jcfranco@users.noreply.github.com>

ci(screener): enlarging screen resolution (#3977)

b26160c

refactor(input): fix all types that are any (#3981)

6908cfe

refactor(slider): remove drag event listeners on component disconnect…

4d7540b

…ed (#3969) * refactor(slider): remove eventListeners on DOM disconnected * feedback changes * add private method for duplicate code * rename method

build: update browserslist db (#3985)

364f623

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

test(input): when both 'ArrowUp' and 'ArrowDown' are pressed at the s…

c18cdac

…ame time most recently pressed key takes over (#3989) Co-authored-by: Eliza Khachatryan <eli97736@esri.com>

y0n4 force-pushed the y0n4/3755-input-status branch from ee0f2bf to c18cdac Compare January 24, 2022 19:27

Merge branch 'master' of github.com:Esri/calcite-components into y0n4…

9c64cb1

…/3755-input-status

jcfranco reviewed Jan 24, 2022

View reviewed changes

src/components/calcite-input/calcite-input.e2e.ts Show resolved Hide resolved

src/components/calcite-label/calcite-label.tsx Outdated Show resolved Hide resolved

Yona Nagayama added 3 commits January 24, 2022 13:30

alter verbiage of deprecated prop

fe1dc20

Merge branch 'master' of github.com:Esri/calcite-components into y0n4…

0021719

…/3755-input-status

Merge branch 'master' of github.com:Esri/calcite-components into y0n4…

29e4af8

…/3755-input-status

Merge branch 'master' of github.com:Esri/calcite-components into y0n…

6456cae

…4/3755-input-status

jcfranco reviewed Jan 27, 2022

View reviewed changes

eriklharper and others added 14 commits January 27, 2022 14:15

ci(screener): restoring pre-Sauce integration settings (#3994)

c2b3327

docs(template): provide context for the repro samples (#3970)

34f9f4b

* docs(templates): provide content for the repro samples * use cc latest version Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

chore: pin node 16 and npm 8 for volta (#3964)

57a556b

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

docs(readme): remove sketch info until it is up to date (#3996)

479a155

fix(date-picker): update utils locale to get the lang code if regiona…

73d50ae

…l code is not found (#3968) * fix(date-picker): update utils locale to get the lang code if regional code is not found * alter util changes based from pr comments

1.0.0-next.374

c719371

ci: allow primary and secondary contacts to merge on all prs (#3999)

ac039d8

* ci: allow primary and secondary contacts to merge on all prs * cleanup * use admin token

fix(date-picker, input-date-picker): update pt-BR and pt-PT localizat…

c43f01b

…ion files (#3980) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

1.0.0-next.375

1cc7b2d

test(dropdown): correct logical errors in the test (#3998)

fbff2f3

* test(dropdown): correct logical errors in the test * assert both events after each toggle action and use page.waitForEvent before doing assertions Co-authored-by: Eliza Khachatryan <eli97736@esri.com>

deprecate and restore the use of status prop

f4b80ec

Merge branch 'y0n4/3755-input-status' of github.com:Esri/calcite-comp…

f9626ae

…onents into y0n4/3755-input-status

restore reading status prop from label

55563bb

y0n4 changed the title ~~fix(label, input, input-message)!: deprecate and no longer support status prop for calcite-label~~ fix(label, input, input-message): deprecate and no longer support status prop for calcite-label Jan 27, 2022

jcfranco changed the title ~~fix(label, input, input-message): deprecate and no longer support status prop for calcite-label~~ feat(label): deprecate status prop Jan 27, 2022

jcfranco approved these changes Jan 27, 2022

View reviewed changes

jcfranco reviewed Jan 27, 2022

View reviewed changes

Merge branch 'master' of github.com:Esri/calcite-components into y0n4…

cb8e3d9

…/3755-input-status

y0n4 merged commit 066571f into master Jan 27, 2022

y0n4 deleted the y0n4/3755-input-status branch January 27, 2022 23:34

benelan mentioned this pull request Jan 31, 2022

docs: update component READMEs #4023

Closed

jcfranco mentioned this pull request Mar 30, 2023

calcite-modal's scale overrides calcite-input's scale #6494

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(label): deprecate status prop #3984

feat(label): deprecate status prop #3984

y0n4 commented Jan 22, 2022 •

edited

Loading

driskull left a comment

jcfranco left a comment •

edited

Loading

driskull commented Jan 27, 2022

jcfranco left a comment

jcfranco Jan 27, 2022

jcfranco Jan 27, 2022

benelan Jan 27, 2022

benelan Jan 27, 2022 •

edited

Loading

feat(label): deprecate status prop #3984

feat(label): deprecate status prop #3984

Conversation

y0n4 commented Jan 22, 2022 • edited Loading

Summary

driskull left a comment

Choose a reason for hiding this comment

jcfranco left a comment • edited Loading

Choose a reason for hiding this comment

driskull commented Jan 27, 2022

jcfranco left a comment

Choose a reason for hiding this comment

jcfranco Jan 27, 2022

Choose a reason for hiding this comment

jcfranco Jan 27, 2022

Choose a reason for hiding this comment

benelan Jan 27, 2022

Choose a reason for hiding this comment

benelan Jan 27, 2022 • edited Loading

Choose a reason for hiding this comment

y0n4 commented Jan 22, 2022 •

edited

Loading

jcfranco left a comment •

edited

Loading

benelan Jan 27, 2022 •

edited

Loading