immersivity_react/README.md

Immersivity React wrapper. Feel the depth.

# Immersivity React Library 🚀

Welcome to the **Immersivity React Library**! This library is a React wrapper for the core Immersivity library, enabling you to create interactive, parallax-based user interfaces that respond to head movements captured by the user's camera. 

## Installation 🛠️

First, install the library via npm or yarn:

```bash
npm install immersivity-react
# or
yarn add immersivity-react
```

## Getting Started 🌟

To start using Immersivity in your React project, follow these steps:

1. **Setup the Provider**: Wrap your application with the `ImmersivityProvider`.

2. **Use Components and Hooks**: Leverage the provided components and hooks to create parallax effects.

Here's a basic example to get you started:

```jsx
import React from 'react';
import { ImmersivityProvider, 
         ParallaxContainer, 
         ParallaxList, 
         useFacePosition, 
         withParallaxClassName } from 'immersivity-react';

const App = () => {
  const handleFacePosition = (position) => {
    console.log('Face position:', position);
  };

  useFacePosition(handleFacePosition);

  return (
    <ImmersivityProvider>
      <div className="App">
        <h1>Welcome to Immersivity</h1>
        <ParallaxList>
          <div>Item 1</div>
          <div>Item 2</div>
          <div>Item 3</div>
        </ParallaxList>
      </div>
    </ImmersivityProvider>
  );
};

export default App;
```

## Components and Hooks 📦

### `ImmersivityProvider`

Wrap your application with `ImmersivityProvider` to initialize the face-tracking functionality.

```jsx
import { ImmersivityProvider } from 'immersivity-react';

const App = () => (
  <ImmersivityProvider>
    {/* Your components here */}
  </ImmersivityProvider>
);
```

### `ParallaxContainer`

A container that applies a parallax effect to its children based on head movements.

```jsx
import { ParallaxContainer } from 'immersivity-react';

const MyComponent = () => (
  <ParallaxContainer>
    <div>Parallax Content</div>
  </ParallaxContainer>
);
```

### `ParallaxList`

A list component that applies the parallax effect to each of its children.

```jsx
import { ParallaxList } from 'immersivity-react';

const MyList = () => (
  <ParallaxList>
    <div>Item 1</div>
    <div>Item 2</div>
    <div>Item 3</div>
  </ParallaxList>
);
```

### `useFacePosition`

A hook that subscribes to face position updates and allows you to perform actions based on these updates.

```jsx
import { useFacePosition } from 'immersivity-react';

const MyComponent = () => {
  useFacePosition((position) => {
    console.log('Face position:', position);
  });

  return <div>Check the console for face position updates.</div>;
};
```

### `withParallaxClassName`

A higher-order component that adds a parallax class name to the wrapped component.

```jsx
import { withParallaxClassName } from 'immersivity-react';

const MyComponent = ({ className }) => (
  <div className={className}>This component has a parallax class name.</div>
);

const EnhancedComponent = withParallaxClassName(MyComponent);
```

## License 📄

```
MIT License

Copyright (c) 2024 Ivan Husarov.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

---

Enjoy creating immersive web experiences with **Immersivity**! If you have any questions or need further assistance, feel free to reach out. Happy coding! 🚀