@gemeente-denhaag/icons

Icons component

📕 View this component in Storybook

✏️ View the icons in Figma

How to use this component

Numerous icons are exported in this component. See the Storybook for all available the icons. An icon can be imported like so:

import { ArrowLeftIcon } from "@gemeente-denhaag/icons";
<ArrowLeftIcon />;

Adding your own icons is very easy. This component exposes SvgIcon which is a wrapper element for svg or children of svg elements.

A path element can be wrapped like so:

import SvgIcon from "@gemeente-denhaag/icons";

const HomeIcon = (props) => (
  <SvgIcon {...props}>
    <path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z" />
  </SvgIcon>
);

The SvgIcon can also take a svg element as property:

import StarIconSvg from "./star.svg";

const StarIcon = (props) => <SvgIcon component={StarIconSvg} viewBox="0 0 600 476.6" {...props} />;

Do note that you will need a sufficient bundler that can handle the direct svg import. For example, svgr is a loader for webpack that can import svg elements and make them usable in react.

Further reading material

• https://material-ui.com/api/svg-icon/
• https://material-ui.com/components/icons/
• https://github.com/gregberge/svgr
• https://github.com/svg/svgo

How to add icons to this component

1. You need a complete svg file. This file can be exported from Figma for example. Make sure that the viewport is "0 0 24 24".

2. Place this file in one of the directories in src/svg. If the file is exported from the Denhaag Figma, it should already be in the correct directory. Then just merge both directories.

3. Update index.tsx by adding:

   import YourIconSvg from "./svg/DIR/YOURICON.svg";
   export const YourIcon: F = (props: SvgIconProps) => buildIcon(YourIconSvg, props);
   

4. View the Storybook to see if it renders correctly. If the colors are incorrect, try changing the fill and stroke of the svg elements and its children. Usually these properties should have the "none" or "currentColor" value. Check the other icons for more details.

   You don't need to update the Storybook story. The icon should be added automagically.

5. Done! ✨