[docs-infra] Add support for data attributes in the API generation #44709
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Netlify deploy previewhttps://deploy-preview-44709--material-ui.netlify.app/ Bundle size report |
mnajdova
commented
Dec 10, 2024
| const attachCssVariables = (reactApi: ComponentReactApi, params: ParsedProperty[]) => { | ||
| const cssVarsErrors: Array<[propName: string, error: Error]> = []; | ||
| const cssVariables: ComponentReactApi['cssVariables'] = params | ||
| const attachTable = ( |
There was a problem hiding this comment.
Repurposed the function to be used with any attribute
mnajdova
commented
Dec 10, 2024
| @@ -7,7 +7,7 @@ export interface Slot { | |||
| default?: string; | |||
| } | |||
|
|
|||
| export interface CssVariable { | |||
| export interface ApiItemDescription { | |||
There was a problem hiding this comment.
Made the name more generic to be reused with different types of API descriptions.
alexfauquette
approved these changes
Dec 10, 2024
| @@ -0,0 +1,13 @@ | |||
| enum AccordionDataAttributes { | |||
| /** | |||
| * Indicates whether the panel is opened | |||
There was a problem hiding this comment.
Suggested change
| * Indicates whether the panel is opened | |
| * Indicates whether the panel is opened. |
There was a problem hiding this comment.
Side note, I was thinking of making a quick PR to fail the CI anytime any of those descriptions doesn't end with a dot. I suspect it's a quick win.
There was a problem hiding this comment.
I am reverting these changes, they are just here to help the reviewer :)
Co-authored-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com> Signed-off-by: Marija Najdova <mnajdova@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds support for API generation for data-* attributes. It works identical to the CSS variables generation. I'll remove the test data after the approval.