Skip to content

Commit

Permalink
docs: remove adding icons documentation (#2058)
Browse files Browse the repository at this point in the history
  • Loading branch information
talkor authored Apr 15, 2024
1 parent f72ce92 commit 71414bd
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 43 deletions.
12 changes: 0 additions & 12 deletions packages/style/ICON_REQUEST.md

This file was deleted.

31 changes: 0 additions & 31 deletions packages/style/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,37 +36,6 @@ import IconName from "monday-ui-style/src/Icons/IconName.svg";
@import "~monday-ui-style/dist/functions";
```

## Icons

### Adding a new icon

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)

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

### Metadata file

We maintain a metadata file for each icon, it helps our icon library be more readable and searchable when searching for relevant icons

How to add a new icon?
Add the icon in SVG format under the src/Icons folder (size 20x20)
then run `yarn generate-meta` and fill in the relevant information (you can add multiple icons and run the command once)

### Icon colors

We want to support the ability for the svg icon to adapt the css `color` attribute, therefore when adding an icon
all of the colors in the SVG should be `currentColor`.

In some rare occasions when you want to preserve a color within the icon please consider the following:

- `currentColor` might change according to position and theming
- this is an open source library so brand colors might change
- please be aware that we will add a monochrome version of that icon as well

## New icon request

To create a non existing monday.com style icon open a PR with please see the [guidelines](ICON_REQUEST.md)

## Stylelint rules

It is recommended to extend our [Stylelint](https://stylelint.io/) config in order to ensure proper usage of this library.
Expand Down

0 comments on commit 71414bd

Please sign in to comment.