bpk-component-icon
v10.1.2
Published
Backpack icon components.
Downloads
10,623
Maintainers
Keywords
Readme
bpk-component-icon
Backpack icon components.
Installation
npm install bpk-component-icon --save-dev
Basic usage
import React from 'react';
import BpkSmallFlightIcon from 'bpk-component-icon/sm/flight';
import BpkLargeAccessibilityIcon from 'bpk-component-icon/lg/accessibility';
import './icons.scss';
export default () => (
<div>
<BpkSmallFlightIcon className="abc-icon__flight" />
<BpkLargeAccessibilityIcon className="abc-icon__a11y" />
</div>
);
icons.scss
:
@import '~bpk-mixins/index.scss';
.abc-icon__flight {
fill: currentColor; // see https://css-tricks.com/currentcolor/
}
.abc-icon__a11y {
fill: $bpk-color-sky-blue;
}
Aligning to BpkButton components
import React from 'react';
import BpkButton from 'bpk-component-button';
import BpkSmallFlightIcon from 'bpk-component-icon/sm/flight';
import BpkLargeAccessibilityIcon from 'bpk-component-icon/lg/accessibility';
import { withButtonAlignment, withLargeButtonAlignment } from 'bpk-component-icon';
const AlignedBpkSmallFlightIcon = withButtonAlignment(BpkSmallFlightIcon);
const AlignedBpkLargeAccessibilityIcon = withLargeButtonAlignment(BpkLargeAccessibilityIcon);
export default () => (
<div>
<BpkButton>
<AlignedBpkSmallFlightIcon />
</BpkButton>
<BpkButton large>
<AlignedBpkLargeAccessibilityIcon />
</BpkButton>
</div>
);
RTL support
import React from 'react';
import BpkSmallFlightIcon from 'bpk-component-icon/sm/flight';
import { withRtlSupport } from 'bpk-component-icon';
import './icons.scss';
const RtlSupportedBpkSmallFlightIcon = withRtlSupport(BpkSmallFlightIcon);
export default () => (
<RtlSupportedBpkSmallFlightIcon className="abc-icon__flight" />
);