chakra-ui-docs icon indicating copy to clipboard operation
chakra-ui-docs copied to clipboard

docs(theme-tools): create doc page for the Theme Tools

Open TylerAPfledderer opened this issue 3 years ago • 1 comments

Closes #206

Add documentation to provide an overview of all the the Theme Tool methods that are publicly available for use in custom theme configs. Does not include the code for the anatomy.

Considerations

Due to the repetitiveness of these methods (as they are mostly primitives in the arguments past and the values returned), it seems better to provide tables listing the methods, a description of what each one does and the value returned, and the basic function call to show what params are asked for in what order. This on it's face can certainly keep the clutter low, and be able to follow up each table with a set of examples from the Chakra source code.

Is creating a big table the best way to go here? This seems to be only needed for the color tools, but I think it's better than isolating each method to it's own section, since most good examples to provide from the source code show a mix of the methods to achieve certain dynamic styling results (getBg() function from the Alert theme, for example)

TylerAPfledderer avatar May 31 '22 22:05 TylerAPfledderer

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
chakra-ui-docs ✅ Ready (Inspect) Visit Preview Jun 8, 2022 at 7:15PM (UTC)

vercel[bot] avatar May 31 '22 22:05 vercel[bot]

We're going to deprecate this package in the next major. Let's close this out.

Thanks for your work on this Tyler

segunadebayo avatar Aug 24 '22 12:08 segunadebayo