JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1667
  • Score
    100M100P100Q112443F
  • License MIT

React icon library for the Health Icons set

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (healthicons-react) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    React Health Icons

    This package provides a simple and easy-to-use interface for accessing all the health icons within your React projects. You can see the full list of icons at healthicons

    healthicons-react is an open source package that exports these Health Icons as React components that can be used in all of your React projects.

    Installation

    yarn add healthicons-react

    or

    npm i healthicons-react

    Usage

    import React from "react";
    import { BloodBag } from "healthicons-react/solid";
    
    const App = () => {
      return <BloodBag />;
    };
    
    export default App;

    Icons can take any standard SVG properties as optional props, e.g.

    <BloodBag color="red" height={36} width={36} />

    Default values for the most common props are given below:

    Prop name Default value
    color "currentColor"
    width "1.5em"
    height "1.5em"
    strokeWidth 1.5
    fill "none"

    HealthIconsProvider

    Tired of specifying the same props for every single icon, every time you use them? So were we. Use HealthIconsProvider to set the default icon props for everything inside HealthIconsProvider.

    import { HealthIconsProvider, BloodBag } from "healthicons-react-native";
    return (
      <HealthIconsProvider
        iconProps={{
          color: "#AAAAAA",
          strokeWidth: 1,
          width: "1em",
          height: "1em",
        }}
      >
        <SomeOtherContainer>
          <BloodBag />
        </SomeOtherContainer>
      </HealthIconsProvider>
    );

    Naming conventions for icons

    The React components in this package are named using the PascalCase convention, which is a variation of their reference names (e.g. add-circle-outline becomes AddCircleOutline). However, some names have been modified to comply with React component naming rules or to match the branding conventions of organizations, such as GitHub. The exceptions to the naming convention are as follows:

    HealthIcons Name React Native Component
    blood-bag BloodBag