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

Refactor: Open/Close events should be publicly exposed for top-level components #4544

Open
5 of 17 tasks
Elijbet opened this issue May 12, 2022 · 6 comments
Open
5 of 17 tasks
Assignees
Labels
1 - assigned Issues that are assigned to a sprint and a team member. blocked This issue is blocked by another issue. estimate - 8 Requires input from team, consider smaller steps. p - medium Issue is non core or affecting less that 60% of people using the library refactor Issues tied to code that needs to be significantly reworked. spike complete Issues that have a research spike completed and dev work can proceed
Milestone

Comments

@Elijbet
Copy link
Contributor

Elijbet commented May 12, 2022

Description

Related Issue: #2256

Summary

Follow-up issue: Open/Close events should be publicly exposed, as these might be useful for users at some point. Especially for a top-level component that isn't emitting this event for another Calcite component to listen for. In that case, just ensure it does not have the @internal label or Internal prefix and is documented.

Proposed Advantages

Users might need control over these.

Which Component

Based on the comment below:
The originating issue for this has been addressed (making combobox open/close events public). Other components could implement OpenCloseComponent with associated events:

open prop:

expanded prop:

  • accordion-item
  • action-bar
  • action-group
  • action-pad
  • tree-item

closed prop:

  • list-item
  • chip
  • tab-title
  • tip
  • tip-manager

collapsed prop:

  • panel
  • shell-panel
  • flow-item

We may also need to tackle #5074 along with this issue.

@Elijbet Elijbet added refactor Issues tied to code that needs to be significantly reworked. 0 - new New issues that need assignment. needs triage Planning workflow - pending design/dev review. labels May 12, 2022
@geospatialem geospatialem added the spike Issues that need quick investigations for time estimations, prioritization, or a quick assessment. label Oct 16, 2023
@geospatialem geospatialem added 1 - assigned Issues that are assigned to a sprint and a team member. and removed 0 - new New issues that need assignment. labels Oct 16, 2023
@geospatialem geospatialem removed the needs triage Planning workflow - pending design/dev review. label Oct 16, 2023
@jcfranco
Copy link
Member

It seems the originating issue for this has been addressed (making combobox open/close events public).

There are other components that could implement OpenCloseComponent with associated events:

open prop

expanded prop

  • accordion-item
  • action-bar
  • action-group
  • action-pad
  • tree-item (expanded prop)

Not sure if we want to address those in a separate PR or repurpose this one.

We may also need to tackle #5074 along with this issue.

@geospatialem geospatialem added p - medium Issue is non core or affecting less that 60% of people using the library estimate - 8 Requires input from team, consider smaller steps. spike complete Issues that have a research spike completed and dev work can proceed labels Dec 19, 2023
@github-actions github-actions bot added 0 - new New issues that need assignment. needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. and removed spike Issues that need quick investigations for time estimations, prioritization, or a quick assessment. 1 - assigned Issues that are assigned to a sprint and a team member. labels Dec 19, 2023
Copy link
Contributor

cc @geospatialem, @brittneytewks

@driskull
Copy link
Member

Do we have an issue to add these kind of events for closed props on panel, flow-item, list-item, etc?

@Elijbet
Copy link
Contributor Author

Elijbet commented Jul 12, 2024

Do we have an issue to add these kind of events for closed props on panel, flow-item, list-item, etc?

I'll add those to this issue as well. openCloseComponent util needs to be modified to account for open, close, expanded, collapsed props.

Items that use closed prop:

  • list-item
  • chip 
  • tab-title
  • tip
  • tip-manager

And collapsed prop for:

  • panel
  • shell-panel
  • flow-item

@Elijbet
Copy link
Contributor Author

Elijbet commented Jul 25, 2024

In order to make components with expanded, collapsed, and closed props openCloseComponents, we will need to first address this issue: Revisit event names emitted by openCloseComponent util#9513

@geospatialem geospatialem added the blocked This issue is blocked by another issue. label Jul 29, 2024
@geospatialem geospatialem added 1 - assigned Issues that are assigned to a sprint and a team member. and removed 0 - new New issues that need assignment. labels Jul 29, 2024
@geospatialem
Copy link
Member

Blocked by the efforts of #9513

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - assigned Issues that are assigned to a sprint and a team member. blocked This issue is blocked by another issue. estimate - 8 Requires input from team, consider smaller steps. p - medium Issue is non core or affecting less that 60% of people using the library refactor Issues tied to code that needs to be significantly reworked. spike complete Issues that have a research spike completed and dev work can proceed
Projects
None yet
Development

No branches or pull requests

5 participants