@suitejs/icon-base v0.2.1

icon-base

Base component for creating React SVG icons.

Installation

$ npm install --save @suitejs/icon-base

Usage

import React from 'react';
import IconBase from '@suitejs/icon-base';

function CheckBox(props) {
  return (
    <IconBase viewBox="0 0 48 48" {...props}>
      <title>check box</title>
      <path d="M38 6H10c-2.21 0-4 1.79-4 4v28c0 2.21 1.79 4 4 4h28c2.21 0 4-1.79 4-4V10c0-2.21-1.79-4-4-4zM20 34L10 24l2.83-2.83L20 28.34l15.17-15.17L38 16 20 34z" />
    </IconBase>
  );
}

Output (with defaults applied):

<svg version="1.1" xmlns="http://www.w3.org/2000/svg" fill="currentColor" height="1.15em" width="1.15em" aria-hidden="true" viewBox="0 0 48 48" style="vertical-align: text-bottom;">
  <title>check box</title>
  <path d="M38 6H10c-2.21 0-4 1.79-4 4v28c0 2.21 1.79 4 4 4h28c2.21 0 4-1.79 4-4V10c0-2.21-1.79-4-4-4zM20 34L10 24l2.83-2.83L20 28.34l15.17-15.17L38 16 20 34z"></path>
</svg>

If you are working with CommonJS modules, you will need to access the default property:

var IconBase = require('@suitejs/icon-base').default;

Back to top

Defaults

Can be overriden via props or context.

fill

Type: string Default: currentColor

Applied to the fill attribute.

size

Type: string|number Default: 1.15em

Applied to the width and height attributes.

height

Type: number|string

Applied to the height attribute. Takes precendence over size.

width

Type: number|string

Applied to the width attribute. Takes precendence over size.

style

Type: object Default:

{
  verticalAlign: 'text-bottom'
}

Shallow merged with the default object. Applied to the style attribute (inline styles).

aria-hidden

Type: boolean Default: true

Applied to the aria-hidden attribute.

Back to top

Global configuration

@suitejs/icon-base exports IconProvider as a named export. You can apply settings/styles globally by passing them as props to IconProvider.

import React from 'react';
import { IconProvider } from '@suitejs/icon-base';

var iconConfig = {
  fill: '#cccccc',
  className: 'icon',
  style: {
    verticalAlign: 'middle',
  },
  // ...
};

function App() {
  return (
    <IconProvider {...iconConfig}>
      {/*
        Any icon components within this tree will receive
        'iconConfig' values
      */}
    </IconProvider>
  );
}

export default App;

Global settings can be overriden inline:

<CheckBox fill="#000000" size="0.75em" aria-hidden={false} />

If you are working with CommonJS modules, you will need to access the IconProvider property:

var IconProvider = require('@suitejs/icon-base').IconProvider;

Back to top