|
| 1 | +--- |
| 2 | +sidebar_position: 2 |
| 3 | +--- |
| 4 | + |
| 5 | +# How to Add Styling to Your Play |
| 6 | + |
| 7 | +Styling is an essential part of any play, and it's crucial to follow best practices to ensure that your code is maintainable and scalable. Here are some **Dos and Don'ts** to keep in mind when adding styling to your play: |
| 8 | + |
| 9 | +## Do's |
| 10 | + |
| 11 | +- Use class names that start with the play name and are in the kebab case. This naming convention helps to keep your code organized and easy to read. |
| 12 | + For example, if your play name is `"my-play"`, your class name should be `my-play__my-class`. |
| 13 | + |
| 14 | +- Use CSS libraries that provide additional features such as [scoped styles](https://developer.mozilla.org/en-US/docs/Web/CSS/:scope) and automatic [vendor prefixing](https://developer.mozilla.org/en-US/docs/Glossary/Vendor_Prefix). |
| 15 | + |
| 16 | +- `Tailwind CSS` support has been enabled in ReactPlay. You can use this CSS library in your play. |
| 17 | + |
| 18 | +- Use CSS modules to style your components. CSS modules allow you to write modular and reusable CSS code that is scoped to a specific component. |
| 19 | + For example, you can create a CSS module for your component like this: |
| 20 | + |
| 21 | +```css |
| 22 | +.my-play__my-class { |
| 23 | + color: red; |
| 24 | +} |
| 25 | +``` |
| 26 | + |
| 27 | +And then import it into your component like this: |
| 28 | + |
| 29 | +```jsx |
| 30 | +import styles from "./MyComponent.module.css"; |
| 31 | + |
| 32 | +function MyComponent() { |
| 33 | + return <div className={styles["my-play__my-class"]}>Hello World</div>; |
| 34 | +} |
| 35 | +``` |
| 36 | + |
| 37 | +- Use `styled-components` to create reusable and composable components. `styled-components` allow you to write CSS code that is scoped to a specific component and can be reused across your project. |
| 38 | + |
| 39 | +## Don'ts |
| 40 | + |
| 41 | +- Do not use inline styles unless necessary. Inline styles can make your code harder to read and maintain, and they can also negatively impact performance. Instead, use CSS classes to style your components. This approach helps to keep your code organized and makes it easier to maintain. |
| 42 | + For example, instead of using inline styles like this: |
| 43 | + |
| 44 | +```jsx |
| 45 | +function MyComponent() { |
| 46 | + return <div style={{ color: "red" }}>Hello World</div>; |
| 47 | +} |
| 48 | +``` |
| 49 | + |
| 50 | +You can create a CSS class and apply it to your component like this: |
| 51 | + |
| 52 | +```css |
| 53 | +.my-play__my-class { |
| 54 | + color: red; |
| 55 | +} |
| 56 | +``` |
| 57 | + |
| 58 | +```jsx |
| 59 | +function MyComponent() { |
| 60 | + return <div className="my-play__my-class">Hello World</div>; |
| 61 | +} |
| 62 | +``` |
| 63 | + |
| 64 | +- Do not use global styles. Global styles can cause naming conflicts and make it harder to maintain your code. Instead, use CSS modules or `styled-components` to create modular and reusable CSS code. |
| 65 | + For example, you can create a CSS module for your component like this: |
| 66 | + |
| 67 | +```css |
| 68 | +.my-play__my-class { |
| 69 | + color: red; |
| 70 | +} |
| 71 | +``` |
| 72 | + |
| 73 | +And then import it into your component like this: |
| 74 | + |
| 75 | +```jsx |
| 76 | +import styles from "./MyComponent.module.css"; |
| 77 | + |
| 78 | +function MyComponent() { |
| 79 | + return <div className={styles["my-play__my-class"]}>Hello World</div>; |
| 80 | +} |
| 81 | +``` |
| 82 | + |
| 83 | +- Do not override the styles using `!important` CSS property. They override all the other declarations and make the CSS code difficult to maintain and debug. Instead, you can use other options to override styles such as using the source order rule, the inherited property rule, or the specificity rule. |
| 84 | + |
| 85 | +By following these dos and don'ts, you can ensure that your play is well-styled, maintainable, and scalable. Remember to choose the approach that works best for your project and to keep your code organized and easy to read. |
| 86 | + |
| 87 | +## ✋ Need Help? |
| 88 | + |
| 89 | +You can reach out to us at [ReactPlay Twitter Handle | @ReactPlayIO](https://twitter.com/ReactPlayIO) with a DM. Additionally, feel free to join our [Discord community](https://discord.gg/vrTxWUP8Am) for discussions. |
0 commit comments