healthicons-react-native
v3.1.0
Published
React Native icon library for the Health Icons set
Downloads
12,261
Maintainers
Readme
React Native Health Icons
This package provides a simple and easy-to-use interface for accessing all the health icons within your React Native projects. You can see the full list of icons at healthicons
healthicons-react-native
is an open source package that exports these Health Icons as React Native components (react-native-svg
) that can be used in all of your React Native projects.
Installation
yarn add healthicons-react-native react-native-svg
or
npm i healthicons-react-native react-native-svg
Usage
By default filled
icons are imported. To import another variant use the following syntax from healthicons-react/[variant_name]
instead.
For the material icons(24px), use from healthicons-react-native/[variant_name]-24px
.
import React from "react";
import { View } from "react-native";
import { BloodBag } from "healthicons-react-native";
const App = () => {
return (
<View>
<BloodBag />
</View>
);
};
export default App;
Icons can take any react-native-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/dist/filled";
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
|