Skip to content

Commit 0f94f7a

Browse files
committed
docs(README): mention default-weight option
1 parent 80e74fe commit 0f94f7a

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'phosphor-icons-tailwindcss': patch
3+
---
4+
5+
add `defaultWeight` / `default-weight` option to README

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ You need to add two classes to your markup:
4646
2. an **specifier** class with the syntax: `ph-[<name><--weight>]`, corresponding to your desired icon.
4747

4848
> [!NOTE]
49-
> `weight` is optional and defaults to "regular" if not specified.
49+
> `weight` is optional and defaults to `defaultWeight` config option, or "regular" if not specified.
5050
5151
For example:
5252

@@ -101,6 +101,7 @@ export default {
101101
prefix: 'ph', // for the icon classes
102102
layer: 'icons', // for the CSS layer
103103
customProperty: '--ph-url',
104+
defaultWeight: 'regular',
104105
})],
105106
};
106107
```
@@ -113,6 +114,7 @@ Similarly, for Tailwind 4:
113114
prefix: ph;
114115
layer: icons;
115116
custom-property: --ph-url; /* use the kebab-case alias to avoid auto-format by stylelint / prettier */
117+
default-weight: regular;
116118
}
117119
```
118120

0 commit comments

Comments
 (0)