CodeCatch Icons

CodeCatch Icons is a React-based icon library intended for all CodeCatch React projects.

Installation

npm install codecatch-icons
# or
yarn add codecatch-icons

example usage

import { SunIcon } from 'codecatch-icons';
const Component = () => {
  return (
    <h4>
      Don't stare directly at the <SunIcon size={24} color="orange" />
    </h4>
  );
};

output

Icon Props

Name	Default	Type	Description
size	24px	number | string	Width and height of icon, can be any CSS unit
color	#F8F9FA	string	Color of icon, can be any CSS legal color value
title		string	Tooltip that specifies extra information about the icon
titleId		string	Id of the title prop

All CodeCatch Icons include and extend the attributes defined in the MDN SVG Attribute reference.

Icons

                                                                                                                                                                                                                                                                                        

Contributing

1. Run git clone https://github.com/codecatchorg/codecatch-icons.git

2. Run npm install to install the dependencies

3. Create a new branch off main

4. Add the desired svg file to the icons directory

5. Run npm run build

6. Run git add .

7. Commit your changes according to semantic-release requirements

8. Run git push

9. Create a PR!