Skip to content

Commit ce803dd

Browse files
committed
📝 Extend README
1 parent d9a8138 commit ce803dd

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,18 @@ The `Setup` mixin can also accept the following options:
108108
|-----------|---------------|---------|
109109
| `includeResets` | `true` | Include reset styles. Set to `false` if you want to use your own CSS resets. |
110110
| `includeHelperClasses` | `true` | Adds global helper classes for CSS. All global helper classes are defined [here](https://github.com/Frontendland/webcoreui/tree/main/src/scss/global). |
111+
| `includeElementStyles` | `true` | Adds styles for native HTML elements, such as `code`, `pre`, or `ul`.
112+
113+
Default component styles can also be changed by overriding the following CSS variables:
114+
115+
```css
116+
:root {
117+
--w-avatar-border: #000;
118+
--w-rating-color: #FFF;
119+
--w-rating-empty-color: #BBB;
120+
--w-rating-size: 18px;
121+
}
122+
```
111123

112124
### Using Components
113125

@@ -133,8 +145,10 @@ import { Accordion } from 'webcoreui/react'
133145

134146
- [Accordion](https://github.com/Frontendland/webcoreui/tree/main/src/components/Accordion)
135147
- [Alert](https://github.com/Frontendland/webcoreui/tree/main/src/components/Alert)
136-
- [ConditionalWrapper](https://github.com/Frontendland/webcoreui/tree/main/src/components/ConditionalWrapper)
148+
- [Avatar](https://github.com/Frontendland/webcoreui/tree/main/src/components/Avatar)
137149
- [Badge](https://github.com/Frontendland/webcoreui/tree/main/src/components/Badge)
138150
- [Button](https://github.com/Frontendland/webcoreui/tree/main/src/components/Button)
139151
- [Card](https://github.com/Frontendland/webcoreui/tree/main/src/components/Card)
152+
- [ConditionalWrapper](https://github.com/Frontendland/webcoreui/tree/main/src/components/ConditionalWrapper)
140153
- [Icon](https://github.com/Frontendland/webcoreui/tree/main/src/components/Icon)
154+
- [Rating](https://github.com/Frontendland/webcoreui/tree/main/src/components/Rating)

0 commit comments

Comments
 (0)