# cf-component-icon

> Cloudflare Icon Component

Latest version **5.0.0** (published 2018-05-08) · BSD-3-Clause license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install cf-component-icon
pnpm add cf-component-icon
yarn add cf-component-icon
bun add cf-component-icon
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2018-05-08 |
| First published | 2015-12-28 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 154.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | James Kyle |
| Maintainers | adamschwartz, cf-ci, cf-ci-write, ereeves, hamidagh, handrews, hturan, inikulin, jculvey, johndotawesome, jparyani-cloudflare, manatarms, marksteyn, miksu, mpint, nkcmr, rreverser, ryan0x44, sejoker, teffenellis, terinjokes, toekneestuck, vasturiano |

## Links

- npm: https://www.npmjs.com/package/cf-component-icon
- npm.io page: https://npm.io/package/cf-component-icon

## Dependencies (2)

- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0
- [cf-style-container](https://npm.io/package/cf-style-container.md) ^9.0.0

## Recent versions

- 5.0.0 (latest) — 2018-05-08
- 1.0.5 (stable) — 2016-02-17
- 4.5.6 — 2018-05-04
- 4.5.5 — 2018-05-02
- 4.5.4 — 2018-05-01
- 4.5.3 — 2018-04-27
- 4.5.2 — 2018-04-24
- 4.5.1 — 2018-04-24
- 4.5.0 — 2018-04-18
- 4.4.0 — 2018-04-12
- 4.3.15 — 2018-04-11
- 4.3.14 — 2018-03-28
- 4.3.13 — 2018-03-28
- 4.3.12 — 2018-03-27
- 4.3.11 — 2018-03-23
- … 55 more at https://npm.io/package/cf-component-icon/versions

## README

# cf-component-icon

> Cloudflare Icon Component

## Installation
Installation with yarn is recommended

```sh

$ yarn add cf-component-icon

```

## Usage

```jsx
import React from 'react';
import { Icon } from 'cf-component-icon';

import { createComponent } from 'cf-style-container';

const ColorWrapper = createComponent(
  () => ({
    backgroundColor: '#f1f1f1',
    paddingTop: '10px',
    paddingBottom: '10px',
    paddingLeft: '15px',
    maxWidth: 750,
    display: 'block'
  }),
  'span'
);
ColorWrapper.setDisplayName('ColorWrapper');

const TextWrapper = createComponent(
  () => ({
    paddingRight: '20px',
    paddingLeft: '5px'
  }),
  'span'
);
TextWrapper.setDisplayName('TextWrapper');

const IconComponent = () => (
  <div>
    <p>Types:</p>
    <p>
      <Icon label="caret-down" type="caret-down" />
      <Icon label="caret-left" type="caret-left" />
      <Icon label="caret-right" type="caret-right" />
      <Icon label="caret-up" type="caret-up" />
      <Icon label="resize-horizontal" type="resize-horizontal" />
      <Icon label="reorder" type="reorder" />
      <Icon label="forward" type="forward" />
      <Icon label="backward" type="backward" />
      <Icon label="left" type="left" />
      <Icon label="right" type="right" />
      <Icon label="collapse" type="collapse" />
      <Icon label="edgeworker" type="edgeworker" />
      <Icon label="expand" type="expand" />
      <Icon label="retarget" type="retarget" />
      <Icon label="linkedin" type="linkedin" />
      <Icon label="twitter" type="twitter" />
      <Icon label="google-plus" type="google-plus" />
      <Icon label="facebook" type="facebook" />
      <Icon label="filter" type="filter" />
      <Icon label="calendar" type="calendar" />
      <Icon label="file" type="file" />
      <Icon label="clipboard" type="clipboard" />
      <Icon label="drive" type="drive" />
      <Icon label="speech" type="speech" />
      <Icon label="flowchart" type="flowchart" />
      <Icon label="flowchart-alt" type="flowchart-alt" />
      <Icon label="hamburger" type="hamburger" />
      <Icon label="list" type="list" />
      <Icon label="gear" type="gear" />
      <Icon label="chart" type="chart" />
      <Icon label="help" type="help" />
      <Icon label="info-sign" type="info-sign" />
      <Icon label="ok-sign" type="ok-sign" />
      <Icon label="exclamation-sign" type="exclamation-sign" />
      <Icon label="refresh" type="refresh" />
      <Icon label="time" type="time" />
      <Icon label="sad" type="sad" />
      <Icon label="happy" type="happy" />
      <Icon label="minus" type="minus" />
      <Icon label="ok" type="ok" />
      <Icon label="pause" type="pause" />
      <Icon label="plus" type="plus" />
      <Icon label="remove" type="remove" />
      <Icon label="search" type="search" />
      <Icon label="lock" type="lock" />
      <Icon label="shield" type="shield" />
      <Icon label="spectrum" type="spectrum" />
      <Icon label="upload" type="upload" />
      <Icon label="wrench" type="wrench" />
      <Icon label="bolt" type="bolt" />
      <Icon label="user" type="user" />
      <Icon label="stream" type="stream" />
    </p>

    <p>Sizes:</p>
    <p>
      <Icon label="2x" size="2x" type="gear" />
      <TextWrapper>2x</TextWrapper>
      <Icon label="2.5x" size="2.5x" type="gear" />
      <TextWrapper>2.5x</TextWrapper>
      <Icon label="3x" size="3x" type="gear" />
      <TextWrapper>3x</TextWrapper>
      <Icon label="3.5x" size="3.5x" type="gear" />
      <TextWrapper>3.5x</TextWrapper>
      <Icon label="4x" size="4x" type="gear" />
      <TextWrapper>4x</TextWrapper>
    </p>

    <p>Colors:</p>
    <p>
      <ColorWrapper>
        <Icon label="default" size="2x" type="search" color="default" />
        <TextWrapper>Default</TextWrapper>
        <Icon label="primary" size="2x" type="caret-right" color="primary" />
        <TextWrapper>Primary</TextWrapper>
        <Icon label="success" size="2x" type="ok" color="success" />
        <TextWrapper>Success</TextWrapper>
        <Icon label="warning" size="2x" type="info-sign" color="warning" />
        <TextWrapper>Warning</TextWrapper>
        <Icon label="danger" size="2x" type="exclamation-sign" color="danger" />
        <TextWrapper>Danger</TextWrapper>
        <Icon label="black" size="2x" type="remove" color="black" />
        <TextWrapper>Black</TextWrapper>
        <Icon label="white" size="2x" type="shield" color="white" />
        <TextWrapper>White</TextWrapper>
      </ColorWrapper>
    </p>
  </div>
);

export default IconComponent;

```

---
_Source: https://npm.io/package/cf-component-icon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._