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.

Sign up for GitHub

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

Jump to bottom

Refactor: Use calciteInternal prefix for internal events #2256

Closed
jcfranco opened this issue Jun 3, 2021 · 3 comments
Closed

Refactor: Use calciteInternal prefix for internal events #2256

jcfranco opened this issue Jun 3, 2021 · 3 comments
Assignees
@geospatialem @benelan
Labels
4 - verified Issues that have been released and confirmed resolved. convention Issues relating to conventions and best practices. good first issue Issues that can be worked on by contributors new to calcite-components. help wanted Issues that the core team needs help with in a sprint. p - low Issue is non core or affecting less that 10% of people using the library refactor Issues tied to code that needs to be significantly reworked.
Milestone
Back burner

Comments

@jcfranco
Copy link
Member

jcfranco commented Jun 3, 2021 •
edited
Loading

Description

For clarity and to minimize unintentional usage, internal events should:

  1. be renamed to use the calciteInternal prefix to make it easier to distinguish between internal/external events. Most internal events should be identifiable by the @internal JSDoc tag.
  2. be stopped from propagating when handled.

Sidebar, an ESLint rule can be authored to catch all internal events that did not have stopPropagation/stopImmediatePropagation called. This would be handled in https://github.com/Esri/eslint-plugin-calcite-components.
@jcfranco jcfranco added convention Issues relating to conventions and best practices. refactor Issues tied to code that needs to be significantly reworked. p - low Issue is non core or affecting less that 10% of people using the library needs triage Planning workflow - pending design/dev review. help wanted Issues that the core team needs help with in a sprint. labels Jun 3, 2021
@jcfranco jcfranco added this to the Backlog milestone Jun 4, 2021
@jcfranco jcfranco removed the needs triage Planning workflow - pending design/dev review. label Jun 4, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the Stale Issues or pull requests that have not had recent activity. label Jul 5, 2021
@jcfranco jcfranco added 0 - new New issues that need assignment. and removed Stale Issues or pull requests that have not had recent activity. labels Jul 6, 2021
@jcfranco jcfranco mentioned this issue Oct 11, 2021
Merged
@jcfranco jcfranco modified the milestones: Freezer, Back burner Oct 19, 2021
@jcfranco jcfranco added the good first issue Issues that can be worked on by contributors new to calcite-components. label Oct 19, 2021
@Elijbet Elijbet self-assigned this May 5, 2022
@Elijbet Elijbet added 2 - in development Issues that are actively being worked on. and removed 0 - new New issues that need assignment. labels May 5, 2022
This was referenced May 6, 2022
Merged
Open
@Elijbet Elijbet added 3 - installed Issues that have been merged to master branch and are ready for final confirmation. and removed 2 - in development Issues that are actively being worked on. labels May 13, 2022
@github-actions github-actions bot assigned benelan and geospatialem and unassigned Elijbet May 13, 2022
@github-actions
Copy link
Contributor

Installed and assigned for verification.

@benelan
Copy link
Member

benelan commented May 17, 2022

Verified on master. All of the events with the @internal jsdoc tag were renamed accordingly. Except for combobox open/close which was discussed in the PR, and issue #4544 was created to expose them.

@benelan benelan closed this as completed May 17, 2022
@benelan benelan 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 May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@geospatialem geospatialem

@benelan benelan

Labels
4 - verified Issues that have been released and confirmed resolved. convention Issues relating to conventions and best practices. good first issue Issues that can be worked on by contributors new to calcite-components. help wanted Issues that the core team needs help with in a sprint. p - low Issue is non core or affecting less that 10% of people using the library refactor Issues tied to code that needs to be significantly reworked.
Projects
None yet
Milestone
Back burner
Development

No branches or pull requests
4 participants
@jcfranco @geospatialem @benelan @Elijbet