@intility/bifrost-react
Version:
React library for Intility's design system, Bifrost.
50 lines (49 loc) • 1.17 kB
JavaScript
import Icon from "./Icon.js";
import IconSpinner from "./Icon.Spinner.js";
import IconStep from "./Icon.Step.js";
/**
* Font awesome icon wrapper
*
* @see https://bifrost.intility.com/react/icon
*
* @example
* import { faCoffee } from "@fortawesome/pro-regular-svg-icons/faCoffee";
*
* <Icon icon={faCoffee} />;
*/
export default Object.assign(Icon, {
/**
* Theme-colored spinner icon with customizable `size`. For more control use `<Icon />` instead.
*
* @example
* <Icon.Spinner />
* // is equivalent to
* <Icon icon={faSpinnerThird} className="bf-icon-spinner bfc-theme" />
*
* @example
* <Icon.Spinner size={64} />
* // is equivalent to
* <Icon
* icon={faSpinnerThird}
* className="bf-icon-spinner bfc-theme"
* style={{ fontSize: 64 }}
* />
*/
Spinner: IconSpinner,
/**
* Step icon, used in menus for step-by step wizards.
*
* @example
* <Icon.Step variant="default" />
*
* @example
* // inside a menu item
* <a href="/step1">
* <Menu.Item>
* <Icon.Step variant="completed" marginRight />
* Step 1
* </Menu.Item>
* </a>
*/
Step: IconStep
});