rfox-avatar-widget v0.0.1

AvatarWidget

AvatarWidget is a React component designed to provide a user interface for exploring, generating, and managing avatars.

Installation

To use AvatarWidgetin your React project, you need to install the package by running this command:

npm install rfox-avatar-widget

Usage

To integrate AvatarWidget into your React application, follow these steps:

1. Import the Component: Import AvatarWidget into your JSX file.

   import { AvatarWidget } from "rfox-avatar-widget";

2. Include the Component in Your JSX: Render the AvatarWidget component, passing apiEndpoint and accessToken as props.

   ReactDOM.render(
     <AvatarWidget
       apiEndpoint="https://api.example.com"
       accessToken="your-access-token"
     />,
     document.getElementById("root"),
   );

3. Standalone Application: To use the widget as a standalone application, pass the apiEndpoint and accessToken via URL parameters. For example:

   http://localhost:3000?api=http://localhost:3001&token=your-access-token

Props

AvatarWidget accepts the following props:

• apiEndpoint (optional): The API endpoint to fetch data from. The default value is http://localhost:3001, which is suitable for local development.
• accessToken: The RFOX ID access token for authentication.

interface Props {
  apiEndpoint?: string;
  accessToken: string;
}

Components

AvatarWidget

The main component that wraps the entire widget with necessary providers.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

N/A

This README provides a basic guide on how to use the AvatarWidget component. For more detailed documentation, please refer to the source code and comments within the components.