Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Epic: Audit components and remove deprecations #5798

Closed
86 tasks done
geospatialem opened this issue Nov 22, 2022 · 8 comments
Closed
86 tasks done

Epic: Audit components and remove deprecations #5798

geospatialem opened this issue Nov 22, 2022 · 8 comments
Assignees
Labels
4 - verified Issues that have been released and confirmed resolved. breaking change Issues and pull requests with code changes that are not backwards compatible. epic Large scale issues to be broken up into sub-issues and tracked via sprints and/or project. refactor Issues tied to code that needs to be significantly reworked.

Comments

@geospatialem
Copy link
Member

geospatialem commented Nov 22, 2022

Purpose

Conduct an audit across components, remove deprecations, and update/remove extraneous/failing tests and stories prior to the launch of 1.0.

cc @driskull

Plan of action for each component

  1. Remove deprecations cc Remove deprecated props/attrs, events, etc. before 1.0.0 #3781
  2. Audit of the following:
    • Props (or any deprecated values)
    • Methods (or any deprecated arguments)
    • Events, including removal of unnecessary (event.detail)
    • CSS variables
    • Named slots
    • Unused utilities/resources
  3. Remove them.
  4. Once deprecations are removed:
    • Remove failing/extraneous Tests
    • Update Storybook Stories
    • Update usage readme files
    • Update readme file description of component if necessary.
    • Check for any components using removed deprecations and update them.
  5. Add a note with the string "deprecated" to any shared files where deprecations need to be removed after this issue has been completed.

Sample Pull Request

When submitting a PR for a component, please refer to #5799 for guidance.

Sample commit message

refactor(action)!: Remove deprecated properties and values. #5798

Sample PR Title

Note the component and what was removed. This can be properties, events, methods, arguments, values, CSS variables, slots.

refactor(action)!: Remove deprecated properties and values.

Sample PR Body

Note the general changes and migration options. This can span multiple lines.

BREAKING CHANGE: Removed the `summary` and `disablePadding` properties.

- Removed the property `summary`, use `description` instead.
- Removed the property `disablePadding`, use the CSS variable `--calcite-block-padding` instead.
BREAKING CHANGE: Removed deprecated events and properties.

- Removed the property `dismissed`, use `closed` instead.
- Removed the property `dismissible`, use `closable` instead.
- Removed the property `summary`, use `description` instead.
- Removed the property `intlBack`, use the `calcite-flow-item` component instead.
- Removed the property `showBackButton`, use `calcite-flow-item` instead.
- Removed the property `beforeBack`, use the `calcite-flow-item` component instead.
- Removed the event `calcitePanelDismiss`, use `calcitePanelClose` instead.
- Removed the event `calcitePanelDismissedChange`, use `calcitePanelClose` instead.
- Removed the event `calcitePanelBackClick`, use the `calcite-flow-item` component instead.
BREAKING CHANGE: Removed the `primary-panel` and `contextual-panel` slots.

- Removed the slot `primary-panel`, use `panel-start` instead.
- Removed the slot `contextual-panel`, use `panel-end` instead.
BREAKING CHANGE: Removed the properties `active`, `itemTitle`, `itemSubtitle`, and `icon`.

- Removed the property `active`, use `expanded` instead.
- Removed the property `itemTitle`, use `heading` instead.
- Removed the property `itemSubtitle`, use `description` instead.
- Removed the property `icon`, use `iconStart` or `iconEnd` instead.

Component audit assignments and progress

@geospatialem geospatialem added 1 - assigned Issues that are assigned to a sprint and a team member. epic Large scale issues to be broken up into sub-issues and tracked via sprints and/or project. labels Nov 22, 2022
@driskull driskull added breaking change Issues and pull requests with code changes that are not backwards compatible. refactor Issues tied to code that needs to be significantly reworked. labels Nov 22, 2022
driskull added a commit that referenced this issue Nov 28, 2022
@driskull driskull added this to the 2023 January Priorities milestone Nov 30, 2022
@driskull
Copy link
Member

@anveshmekala I'm still seeing chip with a deprecatedEventPayload on calciteChipDismiss. Can you fix this?

Can you make sure the other PRs are removing deprecated event payloads.

@driskull
Copy link
Member

Make sure to search the folder for anything with "deprecated".

anveshmekala added a commit that referenced this issue Dec 14, 2022
**Related Issue:** #5798 

BREAKING CHANGE: Removed deprecated event.

Removed the event `calcitePaginationUpdate` event, use
`calcitePaginationChange` event instead.
anveshmekala added a commit that referenced this issue Dec 15, 2022
**Related Issue:** #5798 

BREAKING CHANGE: Removed deprecated event payload.

- Removed the `event.detail` property on the event `calciteChipDismiss`,
use `event.target` instead.
- Removed the `event.detail` property on the event
`calciteComboboxChipDismiss`, use `event.target` instead.
anveshmekala added a commit that referenced this issue Dec 15, 2022
**Related Issue:** #5798

BREAKING CHANGE: Removed deprecated properties.

Removed the property `active`, use `open` instead.
Removed the property `dimissible`, use `closable` property instead.
@stevenalbers
Copy link

radio-button-group No changes necessary

@driskull Is this accurate? The event payload is still using event.detail. I'm guessing it'd use selectedItem, similar to radio-group?

@driskull
Copy link
Member

@stevenalbers yes you're right. We need to deprecate that event detail. cc @geospatialem.

@driskull
Copy link
Member

Looks like we missed calciteRadioButtonGroupChange

@geospatialem
Copy link
Member Author

Added a new issue for tracking the calciteRadioButtonChange event payload refactor: #6130

@geospatialem geospatialem added 3 - installed Issues that have been merged to master branch and are ready for final confirmation. and removed 1 - assigned Issues that are assigned to a sprint and a team member. labels Jan 14, 2023
@github-actions
Copy link
Contributor

Installed and assigned for verification.

@geospatialem geospatialem added 4 - verified Issues that have been released and confirmed resolved. and removed 3 - installed Issues that have been merged to master branch and are ready for final confirmation. labels Jan 18, 2023
@geospatialem
Copy link
Member Author

Verified on master. ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - verified Issues that have been released and confirmed resolved. breaking change Issues and pull requests with code changes that are not backwards compatible. epic Large scale issues to be broken up into sub-issues and tracked via sprints and/or project. refactor Issues tied to code that needs to be significantly reworked.
Projects
None yet
Development

No branches or pull requests

8 participants