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

[UI components]: Update style helper docs for unstable #1654

Merged
merged 2 commits into from
Jan 15, 2024

Conversation

oliverigor
Copy link
Contributor

What problem are you trying to solve? 💡

complete https://github.com/Shopify/checkout-web/issues/23677 fix, that wasn't included in all versions

How are you solving it? 🛠️

  • For NonPresentationalAccessibilityRole I took JF's suggestion and just duplicated a bit of code since generate-docs cannot handle Exclude property right, and to avoid future errors I opted to not use Pick property as well.
  • For conditional styles I end up simplifying some of the types along with @ncardeli, and created a simplified version for docs only, that way we were able to avoid the infinite loop when trying to access the property on the docs.

Tophat 🎩

Spin Instance 🌀

https://shopify-dev.conditional-styles-doc-fixes.igor-deoliveiramartins.us.spin.dev/docs/api/checkout-ui-extensions

Before
Screenshot 2023-12-06 at 11 16 01 AM
Screenshot 2023-12-06 at 11 18 32 AM

After
Screenshot 2024-01-15 at 12 00 15 PM

Screenshot 2023-12-06 at 11 19 04 AM -8ad4-d909d41d3da3">

Checklist

  • I have 🎩'd these changes
  • I have updated relevant documentation

@oliverigor oliverigor changed the title update style helper docs [UI components]: Update style helper docs for unstable Jan 15, 2024
@oliverigor oliverigor marked this pull request as ready for review January 15, 2024 15:11

This comment has been minimized.

Copy link
Contributor

@jamesvidler jamesvidler left a comment

Choose a reason for hiding this comment

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

Looks good 👍. You'll just need to add a changeset for this as a 'patch'.

Copy link
Contributor

@ncardeli ncardeli left a comment

Choose a reason for hiding this comment

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

:shipit:

@oliverigor oliverigor merged commit e096e9a into unstable Jan 15, 2024
5 checks passed
@oliverigor oliverigor deleted the rusty/style-helper-doc-fix-unstable branch January 15, 2024 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants