Add theme-tools to documentation

[ryanirilli]

Subject

Switch

Description

We have noticed that there is a need to use the cssVar export from @chakra/theme-tools to properly style the Switch component size. This is not a part of the official framework documentation for component style.

If using cssVar for styling Chakra components is a public part of the theme framework and not an implementation detail, it should be documented in CSS variables and in the components that require its usage.

Discord conversation Codesandbox example

Thank you for your consideration!

[noobinthisgame]

Thanks for your feedback @ryanirilli, we will look into this and update docs accordingly :)

[nikolovlazar]

Some of the @chakra-ui/theme-tools functionalities are meant for internal use only, so maybe @segunadebayo can provide his input on this one.

[segunadebayo]

@nikolovlazar The theme tools can be used publicly. We mentioned it in the docs somewhere (I think breakpoints).

So yes, @ryanirilli is right. We should document the public API in theme tools so others can learn about it.

Some ideas to consider:

• Perhaps a dedicated theme tools page might help document all the tools available to our users.
• Add cssVar docs to the CSS variable page
• Create an anamtomy page to document the anatomy

[noobinthisgame]

@segunadebayo About the anatomy. I would put the anatomy and parts of the different components on their respective pages, to help the discoverability. That could also play into what we want to achieve in this issue https://github.com/chakra-ui/chakra-ui-docs/issues/75

[stale[bot]]

Hi! This issue has been automatically marked as stale because lack of recent activity. It will be closed if no further activity occurs within 5 days. Thank you for your contributions.

[TylerAPfledderer]

Could I be assigned to this? Unless someone else has already been working on it behind the scenes, I've started a draft of it... At least a page for the main set of tools.

The only other thing about this group is that some of them have been notated as deprecated, to be removed "in the next major release". But these were notated prior to v2. Is there still a plan to deprecate them, to be replaced by something else?

[noobinthisgame]

Go for it @TylerAPfledderer 🚀🚀

[stale[bot]]

Hi! This issue has been automatically marked as stale because lack of recent activity. It will be closed if no further activity occurs within 5 days. Thank you for your contributions.

[TylerAPfledderer]

Not stale

[stale[bot]]

Hi! This issue has been automatically marked as stale because lack of recent activity. It will be closed if no further activity occurs within 5 days. Thank you for your contributions.

[stale[bot]]

Hi! This issue has been automatically marked as stale because lack of recent activity. It will be closed if no further activity occurs within 5 days. Thank you for your contributions.

[stale[bot]]

Hi! This issue has been automatically marked as stale because lack of recent activity. It will be closed if no further activity occurs within 5 days. Thank you for your contributions.

[stale[bot]]

Hi! This issue has been automatically marked as stale because lack of recent activity. It will be closed if no further activity occurs within 5 days. Thank you for your contributions.

[stale[bot]]

Hi! This issue has been automatically marked as stale because lack of recent activity. It will be closed if no further activity occurs within 5 days. Thank you for your contributions.