Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document theming for custom components #864

Closed
anicholls opened this issue Sep 25, 2020 · 3 comments
Closed

Document theming for custom components #864

anicholls opened this issue Sep 25, 2020 · 3 comments

Comments

@anicholls
Copy link
Contributor

anicholls commented Sep 25, 2020

🚀 Feature Proposal

The helpful useTheme() hook and styled function are not documented here: https://github.com/Workday/canvas-kit/blob/master/modules/react/common/lib/theming/README.md

Motivation

We should add documentation for building your own custom components using the custom theme so people know they can use it in their own components!

@anicholls anicholls added the documentation Affects documentation label Sep 25, 2020
@jpante jpante added the p:2 label Dec 7, 2020
@jaclynjessup jaclynjessup removed the p:2 label Aug 5, 2022
@jaclynjessup jaclynjessup removed the documentation Affects documentation label Sep 1, 2022
@RayRedGoose
Copy link
Contributor

It's still an issue, and requires update documentation on theming.

It good to mention styled function, because it helps to automatically switch direction-sensitive styles for RTL and LTR directions).
useTheme is used in one example (breakpoints) but no overview and information about other functionality.

Also, storybook theming page is pretty empty, so we need to add all this info to storybook too.

@jaclynjessup
Copy link
Member

#923

@jaclynjessup jaclynjessup mentioned this issue Feb 7, 2023
4 tasks
@myvuuu
Copy link
Collaborator

myvuuu commented Jun 29, 2023

Closing this out since we'll be revisiting and documenting theming as part of the v10 work.

@myvuuu myvuuu closed this as completed Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

No branches or pull requests

5 participants