Coder Social home page Coder Social logo

react-native-face-highlighter's Introduction

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

react-native-face-highlighter's People

Contributors

hichamelbsi avatar dependabot[bot] avatar mphill avatar pooooriya avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.