Skip to content

Commit

Permalink
Move icon guideline documention to /docs folder.
Browse files Browse the repository at this point in the history
Also added reference in icons folder.

DDFFORM-6
  • Loading branch information
LasseStaus committed Dec 8, 2023
1 parent c8dad19 commit bce6f1c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
16 changes: 16 additions & 0 deletions docs/Icon-guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Icon Usage Guidelines

This folder contains SVG icons that are used in the design system. When using
icons from this folder, please follow the guidelines below:

- Icons located in public/ folder is the current source of truth. All icons
will be placed in this folder. Ensure that icons placed gere are using the
`class` attribute, and not `className` for SVG element.

- For icons used in React components that require class modifications or
similar, first create the icon in public/icons, and then manually copy the SVG
from the `public/icons` folder and make any necessary changes, i.e replacing
the `class` with `className` or other modifications.

Currently, there is no automated solution for this process that ensures
consistency for this. This may be changed in the future.
8 changes: 1 addition & 7 deletions public/icons/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
# Icon Usage Guidelines

This folder contains SVG icons that are used in the design system. When using icons from this folder, please follow the guidelines below:

- Icons located in public/ folder is the current source of truth. All icons will be placed in this folder. Ensure that icons placed gere are using the `class` attribute, and not `className` for SVG element. This is necessary for the icons to work properly when the folder is copied over using the "dapple"-setup.

- For icons used in React components that require class modifications or similar, first create the icon in public/icons, and then manually copy the SVG from the `public/icons` folder and make any necessary changes, i.e replacing the `class` with `className` or other modifications.

Currently, there is no automated solution for this process that ensures consistency for this. This may be changed in the future.
For information on how to use icons for this project, see [icon-guidelines.md](../../docs/Icon-guidelines.md).

0 comments on commit bce6f1c

Please sign in to comment.