-
Notifications
You must be signed in to change notification settings - Fork 6
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
DSD-1637: Update Content Display Chakra #1471
DSD-1637: Update Content Display Chakra #1471
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Your pull request is missing a changelog—was that intentional? |
6787c5d
to
4c0a174
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The update itself looks great, thanks!
The only thing missing is changelog updates. Can you update the respective storybook files to include "prerelease" in the version table and also add helperErrorTextChangelogData.ts
and statusBadgeChangelogData.ts
files? They can similar to this: https://github.com/NYPL/nypl-design-system/pull/1468/files#diff-8bc92befba3589679a49736327283e9bf375f12582239b94874b15c9312ce479
and then added to a changelog section in the .mdx
file at the very end.
import { createMultiStyleConfigHelpers } from "@chakra-ui/styled-system"; | ||
import { defineStyle, StyleFunctionProps } from "@chakra-ui/system"; | ||
|
||
interface HelperErrorTextBaseStyle extends StyleFunctionProps { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes sense and I see why I didn't need this in the Checkbox
PR, this is needed when you are passing props to the theme functions.
import { createMultiStyleConfigHelpers } from "@chakra-ui/styled-system"; | ||
import { defineStyle, StyleFunctionProps } from "@chakra-ui/system"; | ||
|
||
interface HelperErrorTextBaseStyle extends StyleFunctionProps { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just FYI, I ran into an issue where this caused a problem:
It's not a problem for this component or interface but if you run into the same problem, it can be fixed by making it a partial Partial<StyleFunctionProps>
. We do need to extend the interface but we don't need to make all the properties required.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To keep it consistent I make the change here too. It might be better in the long run.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We talked about this offline but for history: we couldn't figure out why Chakra is being inconsistent and why not using Partial<StyleFunctionProps>
in this case breaks. So for this case (it might be a case-by-case basis), it's okay to not use Partial
.
Fixes JIRA ticket xxx
This PR does the following:
How has this been tested?
Locally
Accessibility concerns or updates
N/A
Checklist:
Front End Review: