Skip to content

Commit 23630e1

Browse files
committed
feat(pxtorem): update README to clarify minValue option and provide usage example
1 parent c48c216 commit 23630e1

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

packages/pxtorem/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ The plugin accepts the following options:
4444

4545
- `rootValue` (default: `16`): The root font size to use for the conversion. This is typically set to `16px`, which is the default font size in most browsers.
4646
- `unitPrecision` (default: `4`): The number of decimal places to use for the converted values.
47+
- `minValue` (default: `0`): The minimum value to convert. Also supports `negative` and `float` values.
4748

4849
## 🚀 Usage
4950

@@ -101,6 +102,7 @@ export default defineConfig({
101102
pxtorem({
102103
rootValue: 18,
103104
unitPrecision: 2,
105+
minValue: 10,
104106
}),
105107
]),
106108
},
@@ -142,7 +144,7 @@ h1 {
142144
}
143145
```
144146

145-
See others examples in the [test folder](https://github.com/felixicaza/lightningcss-plugins/blob/main/packages/pxtorem/test/index.test.ts).
147+
See others examples in the [test folder](https://github.com/felixicaza/lightningcss-plugins/blob/main/packages/pxtorem/test).
146148

147149
## 🤝 Contributing
148150

0 commit comments

Comments
 (0)