About

InvitePeopleModal is a react usable component for inviting users to the website.

Invite People modal component interact with the application, but without jumping to a new page and interrupting the user's workflow.

Usage

Dependencies

Install react fontawsome using the following command:

npm i --save @fortawesome/fontawesome-svg-core

npm install --save @fortawesome/free-regular-svg-icons

Setup

1. Install the InvitePeopleModal component.

npm install invite-modal --save

2. Import the InvitePeopleModal.

import InvitePeopleModal from "invite-modal";

3. Mount the InvitePeopleModal component on the DOM

ReactDOM.render(<InvitePeopleModal />, document.getElementById("root"));

4. Run the App

npm start

Setup for running the development version

1. Open the index.js file & Uncomment the "Development code" part & comment on the "Production Code" part.

2. Run npm start.

Command for running the test cases

npm test -- --coverage

Props of InvitePeopleModal component

| Props | Type | Description | | ------------------- | -------- | ------------------------------------------------------------------------------------------------------ | | triggerElement |htmlelement| Set the element by clicking on which modal will open | | uri | string | Link of the api end-point | | navigate | function | Utility function to change the page/screens | | mobileheader |htmlelement| Header which will be visible on mobile while modal is active | | organizationname | string | Name of organization | | organizationId | string | Id of organization |