You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/style/README.md
-31Lines changed: 0 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -36,37 +36,6 @@ import IconName from "monday-ui-style/src/Icons/IconName.svg";
36
36
@import"~monday-ui-style/dist/functions";
37
37
```
38
38
39
-
## Icons
40
-
41
-
### Adding a new icon
42
-
43
-
In order to add a new icon you will need to [fork the repo and open a PR](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
44
-
45
-
When adding a new icon please make sure that there isn't a similar icon - if so, either replace the icon or make sure that we need another version of it
46
-
47
-
### Metadata file
48
-
49
-
We maintain a metadata file for each icon, it helps our icon library be more readable and searchable when searching for relevant icons
50
-
51
-
How to add a new icon?
52
-
Add the icon in SVG format under the src/Icons folder (size 20x20)
53
-
then run `yarn generate-meta` and fill in the relevant information (you can add multiple icons and run the command once)
54
-
55
-
### Icon colors
56
-
57
-
We want to support the ability for the svg icon to adapt the css `color` attribute, therefore when adding an icon
58
-
all of the colors in the SVG should be `currentColor`.
59
-
60
-
In some rare occasions when you want to preserve a color within the icon please consider the following:
61
-
62
-
-`currentColor` might change according to position and theming
63
-
- this is an open source library so brand colors might change
64
-
- please be aware that we will add a monochrome version of that icon as well
65
-
66
-
## New icon request
67
-
68
-
To create a non existing monday.com style icon open a PR with please see the [guidelines](ICON_REQUEST.md)
69
-
70
39
## Stylelint rules
71
40
72
41
It is recommended to extend our [Stylelint](https://stylelint.io/) config in order to ensure proper usage of this library.
0 commit comments