[docs] Further template the CSS API descriptions #24360
Conversation
docs/scripts/buildApi.ts
Outdated
| const TEST = false; | ||
| // const TEST = 'Accordion'; |
There was a problem hiding this comment.
It seems to me we can remove this and related code entirely in favor of yarn docs:api --grep ButtonBase which got introduced in #21731.
Or is you workflow not supported by --grep?
There was a problem hiding this comment.
I had missed that it's now supported by yarn docs:api. That works for me! 👍🏼
There was a problem hiding this comment.
I'll try to remember to mention script changes in slack (as a simple form of a changelog).
| /** Class name applied to the root element if `color="primary"`. */ | ||
| /** Styles applied to the root element if `color="primary"`. */ | ||
| colorPrimary?: string; |
There was a problem hiding this comment.
I think that "Class name" makes more sense in v5. The component does no longer apply any style with these classes cc @mnajdova.
There was a problem hiding this comment.
Agree, we should use "Class name" - another bullet point for me to check if it is updated in all components.
There was a problem hiding this comment.
I had missed that "Class name" was used for unstyled components. I'll revert that commit.
There was a problem hiding this comment.
Should it also be used for the styled components? (ahead of time of the whole migration to emotion)
I was conscious of the trade-off. If it proves to be a problem, it should be straightforward to test that the "reconstructed" string matches the source. |
This reverts commit 4ef119d.
I've simplified it, so it should be much clearer now. |
mbrookes
force-pushed
the
docs-api-stylesapplied
branch
from
7abef31 to
27e4591
Compare
Minimise manual translations on Crowdin