Skip to content

Dineshmani3/react-native-body-highlighter

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

87 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

react-native-body-highlighter

npm Downloads CircleCI

SVG human body parts highlighter for react-native.

body-highlighter body-highlighter

Installation

$ npm install react-native-body-highlighter --save

or use yarn

$ yarn add react-native-body-highlighter

Usage

Note: If you don't use Expo, ensure to add react-native-svg to your project before using this package.

The snippet below shows how the component can be used

import { StyleSheet, Switch, View } from "react-native";
import { useState } from "react";
import Body from "react-native-body-highlighter";

export default function App() {
  const [bodyPartSelected, setBodyPartSelected] = useState({
    slug: "biceps",
    intensity: 2,
  });
  const [isBackSideEnabled, setIsBackSideEnabled] = useState(false);
  const toggleSwitch = () =>
    setIsBackSideEnabled((previousState) => !previousState);

  return (
    <View style={styles.container}>
      <Body
        data={[
          { slug: "chest", intensity: 1 },
          { slug: "abs", intensity: 2 },
          { slug: "upper-back", intensity: 1 },
          { slug: "lower-back", intensity: 2 },
          bodyPartSelected,
        ]}
        onBodyPartPress={(e) =>
          setBodyPartSelected({ slug: e.slug, intensity: 2 })
        }
        side={isBackSideEnabled ? "back" : "front"}
        scale={1.7}
      />
      <Switch onValueChange={toggleSwitch} value={isBackSideEnabled} />
      <StatusBar style="auto" />
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    backgroundColor: "#fff",
    alignItems: "center",
    justifyContent: "center",
  },
});

v3.X.X Props

Prop Required Purpose
data Yes BodyPartObject[] - Array of BodyPartObject to highlight
onBodyPartPress No Func - (bodyPart: BodyPartObject) => {} Callback called when a user tap a body part
colors No String[] - Defaults to ['#0984e3', '#74b9ff']
side No String - Can be "back" or "front" Display only the front, Defaults to front
scale No Float - Defaults to 1

v2.X.X Props

Prop Required Purpose
data Yes (Array) Array of BodyPartObject to highlight
onMusclePress No (Func) (bodyPart: BodyPartObject) => {} Callback called when a user tap a body part, disabled if zoomOnPress is set to true
colors No (Array) Defaults to ['#0984e3', '#74b9ff']
frontOnly No (Boolean) Display only the front, Defaults to false
backOnly No (Boolean) Display only the back, Defaults to false
zoomOnPress No (Boolean) Defaults to false
scale No (Float) Defaults to 1

BodyPart object model

  • BodyPartObject : { slug: BodyPartName, intensity: IntensityNumber }

  • BodyPartName : Body part name to highlight (See the list of available body parts below)

  • IntensityNumber : Color intensity (if the colors property is set: from 1 to colors.length + 1. If not, intensity can be 1 or 2)

List of body parts

BodyParts v2 v3 Side
trapezius βœ… βœ… Both
triceps βœ… βœ… Both
forearm βœ… βœ… Both
obliques βœ… βœ… Both
adductors βœ… βœ… Both
calves βœ… βœ… Both
head βœ… βœ… Both
neck βœ… βœ… Both
chest βœ… βœ… Front
biceps βœ… βœ… Front
abs Β  βœ… βœ… Front
upper-back βœ… βœ… Back
lower-back βœ… βœ… Back
hamstring βœ… βœ… Back
gluteal βœ… βœ… Back
deltoids Β  ❌ βœ… Both
hands ❌ βœ… Both
feet ❌ βœ… Both
ankles ❌ βœ… Both
tibialis ❌ βœ… Both
adductor βœ… ❌ Both
front-deltoidsΒ  βœ… ❌ Front
abductors βœ… ❌ Front
back-deltoids Β  βœ… ❌ Back

About

react-native-body-highlighter πŸ’ͺ

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.7%
  • JavaScript 0.3%