question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add theme-tools to documentation

See original GitHub issue

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!

Issue Analytics

  • State:open
  • Created 2 years ago
  • Comments:12 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
segunadebayocommented, Mar 16, 2022

@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
0reactions
stale[bot]commented, Oct 30, 2022

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Add more documentation of each Components theme object #75
I am wondering if we could create a more user friendly documentation around the theme file. Taking Input component as an example, we...
Read more >
@chakra-ui/theme-tools | Yarn - Package Manager
Important: This documentation covers modern versions of Yarn. For 1.x docs, see classic.yarnpkg.com. Yarn.
Read more >
@theme-tools/plugin-sass - npm
Add your own custom Sass importer by passing in an array of functions according to those docs. Setup Details. Setting up Stylelint. This...
Read more >
Customize Theme - Chakra UI
Customize the component styles, changing the base styles, sizes, or variants. Customize the global styles. ... import { mode } from '@chakra-ui/theme-tools'.
Read more >
InDesign Tutorial - Color Theme Tool Tutorial - YouTube
Enroll in our new, 13-hour Adobe InDesign Complete Course: https://www.udemy.com/complete-adobe-indesign-course/?
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found