Skip to content
This repository has been archived by the owner on Jan 23, 2024. It is now read-only.

Component styling doc is unclear, lacking and misleading #1628

Open
embostan opened this issue Jul 29, 2023 · 0 comments
Open

Component styling doc is unclear, lacking and misleading #1628

embostan opened this issue Jul 29, 2023 · 0 comments
Labels
needs triage Topic: Documentation 📚

Comments

@embostan
Copy link

embostan commented Jul 29, 2023 •
edited
Loading

Subject

Component Styling

Description

https://github.com/chakra-ui/chakra-ui-docs/blob/0bc42c4c0845554794112f9d46cd236403eaf1e1/content/docs/styled-system/component-style.mdx

This doc page does not explain which props belong to which group (baseStyle, size, ...), which can lead users to override a prop in the wrong place and wonder why no visual change happens: chakra-ui/chakra-ui#3293

Some parts are even misleading:
image
I would infer from this that any prop can be specified in baseStyle, and that the following groups (size, variants...) override baseStyle.
@embostan embostan changed the title Component styling doc is unclear and lacking Component styling doc is unclear, lacking and misleading Jul 29, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
needs triage Topic: Documentation 📚
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@embostan