search

chakra-ui / chakra-ui-docs

Documentation website for chakra ui
https://chakra-ui.com
MIT License
300 stars 478 forks source link

Component styling doc is unclear, lacking and misleading #1628

Open StanLaurent opened 11 months ago

StanLaurent commented 11 months ago

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: https://github.com/chakra-ui/chakra-ui/issues/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.