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(storybook): consolidate storybook and component types #9500

Merged

Conversation

aPreciado88
Copy link
Contributor

@aPreciado88 aPreciado88 commented Jun 3, 2024

Related Issue: #9418

Summary

  • Consolidates all types contained in packages/calcite-components/.storybook/interfaces.ts and packages/calcite-components/src/components/interfaces.ts
  • Updates components to only pick up types that they support.

@github-actions github-actions bot added the refactor Issues tied to code that needs to be significantly reworked. label Jun 3, 2024
…eciado88/9418-consolidate-storybook-and-component-types
@aPreciado88 aPreciado88 added pr ready for visual snapshots Adding this label will run visual snapshot testing. skip visual snapshots Pull requests that do not need visual regression testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels Jun 3, 2024
Copy link
Member

@jcfranco jcfranco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside from a few cleanup comments, this LGTM!

@anveshmekala @driskull @Elijbet @eriklharper @macandcheese can you give this a quick look? 👀

@@ -53,7 +53,10 @@ export class TileGroup implements InteractiveComponent, SelectableGroupComponent
*
* Use `"horizontal"` for rows, and `"vertical"` for a single column.
*/
@Prop({ reflect: true }) layout: Exclude<Layout, "grid"> = "horizontal";
@Prop({ reflect: true }) layout: Exclude<
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on this PR, I think it's better if we change this to Extract instead. Applies to other relevant exclusions.

@@ -14,15 +14,14 @@ import {
import { focusFirstTabbable, toAriaBoolean } from "../../utils/dom";
import { isActivationKey } from "../../utils/key";
import { connectLocalized, disconnectLocalized, LocalizedComponent } from "../../utils/locale";
import { FlipContext } from "../interfaces";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we submit these import-only changes separately?

@@ -1,4 +1,2 @@
export type ArrowType = "inline" | "edge" | "none";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can leave component-specific types where they are. Anything that's shared should go in src/components/interfaces.ts. Some new types might need to be moved to component-level interfaces.ts files.

@aPreciado88
Copy link
Contributor Author

@jcfranco I updated the PR based on your comments. I'll create a new PR to submit the import-only changes

@aPreciado88 aPreciado88 added this to the 2024-06-25 - Jun Release milestone Jun 4, 2024
@aPreciado88 aPreciado88 merged commit 4faa160 into main Jun 5, 2024
9 checks passed
@aPreciado88 aPreciado88 deleted the aPreciado88/9418-consolidate-storybook-and-component-types branch June 5, 2024 22:50
benelan added a commit that referenced this pull request Jun 10, 2024
…orkflow

* origin/main: (26 commits)
  revert: refactor: add simpler `componentFocusable` util (deprecates `LoadableComponent`) (#9515)
  chore(linting): enable selector-pseudo-element-colon-notation rule (#9518)
  refactor(storybook): refactor tooltip simple story interface (#9538)
  refactor(dom): consolidate transition/animation waiting utils (#9341)
  refactor(storybook): build storybook simple story args interfaces using component class (#9457)
  chore: release next
  fix(block): add accessible label for slotted controls (#9502)
  feat(action-bar, action-pad): add expandLabel and collapseLabel to messages (#9497)
  chore: release next
  feat(action-menu, combobox, dropdown, input-date-picker, popover): allow logical placements for flipPlacements property. #8825 (#9490)
  fix(popover): correct border radius on close button (#9485)
  fix(list-item): hide nested list items by default (#9474)
  refactor: move component types into component specific interfaces files (#9527)
  chore: release next
  fix(alert): pause auto-close alert when link focused (#9503)
  refactor(storybook): consolidate storybook and component types (#9500)
  refactor(calcite-block-section,calcite-card): consolidate interfaces imports (#9517)
  chore: release next
  fix(block-section): restore block toggling when clicking on the header switch (#9472)
  chore: release next
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Issues tied to code that needs to be significantly reworked. skip visual snapshots Pull requests that do not need visual regression testing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants