mirror of
https://github.com/tuono-labs/tuono
synced 2026-07-25 12:52:47 -07:00
docs: add /styles/css-modules page (#513)
This commit is contained in:
committed by
GitHub
parent
2cbe53f7b7
commit
674a817131
@@ -7,8 +7,49 @@ import MetaTags from '@/components/MetaTags'
|
|||||||
|
|
||||||
import Breadcrumbs from '@/components/Breadcrumbs'
|
import Breadcrumbs from '@/components/Breadcrumbs'
|
||||||
|
|
||||||
<Breadcrumbs breadcrumbs={[{ label: 'Styles' }]} />
|
<Breadcrumbs breadcrumbs={[{ label: 'CSS Modules' }]} />
|
||||||
|
|
||||||
# CSS Modules
|
# CSS Modules
|
||||||
|
|
||||||
TODO
|
## Overview
|
||||||
|
|
||||||
|
A CSS Module is a CSS file in which all class names and animation names are scoped locally by default.
|
||||||
|
This helps avoid name collisions by ensuring that styles are only applied to the component where they are defined.
|
||||||
|
|
||||||
|
Tuono supports CSS modules out of the box.
|
||||||
|
|
||||||
|
For more information, you can refer to the official [CSS Modules repository](https://github.com/css-modules/css-modules).
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
Any CSS file ending with `.module.css` is considered a CSS modules file.
|
||||||
|
|
||||||
|
Given the following file:
|
||||||
|
|
||||||
|
```css
|
||||||
|
/* ExampleComponent.module.css */
|
||||||
|
.awesome {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
|
||||||
|
.awesome-things {
|
||||||
|
background: #fff;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Importing such file will return the corresponding module object:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
/* ExampleComponent.tsx */
|
||||||
|
import { JSX } from 'react'
|
||||||
|
|
||||||
|
import styles from './example.module.css'
|
||||||
|
|
||||||
|
export function ExampleComponent(): JSX.Element {
|
||||||
|
return (
|
||||||
|
<div className={styles.awesome}>
|
||||||
|
<div className={styles['awesome-things']}>ExampleComponent</div>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user