# Icons

The icons package exports specific Times icons, that can be configured with four
options:

- `fillColour` - sets the color inside the object
- `strokeColour` - sets the color of the line drawn around the object
- `height`
- `width`

The icons include `diamond`, `email`, `facebook`, `star`, `twitter`, and
`video`.

## Contributing

Please read [CONTRIBUTING.md](./CONTRIBUTING.md) before contributing to this
package

## Running the code

Please see our main [README.md](../README.md) to get the project running locally

## Development

The code can be formatted and linted in accordance with the agreed standards.

```
yarn fmt
yarn lint
```

## Testing

This package uses [yarn](https://yarnpkg.com) (latest) to run unit tests on each
platform with [jest](https://facebook.github.io/jest/).

```
yarn test:web
```

Visit the official
[storybook](http://components.thetimes.co.uk/?knob-Size%20of%20ad%20placeholder%3A=default&knob-Icon%20IconStar%20fill=%231D1D1B&knob-Icon%20IconEmail%20fill=%231D1D1B&knob-Icon%20IconVideo%20fill=%231D1D1B&knob-Icon%20IconFacebook%20fill=%231D1D1B&knob-Icon%20IconDiamond%20fill=%231D1D1B&knob-Icon%20IconTwitter%20fill=%23006699&selectedKind=Primitives%2FIcons&selectedStory=Icons&full=0&addons=1&stories=1&panelRight=0&addonPanel=storybooks%2Fstorybook-addon-knobs)
to see our available icons templates.