Skip to content

Commit c47f280

Browse files
liliankasemzmmille2
authored andcommitted
Update README
1 parent 0dd8b86 commit c47f280

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ React AAD MSAL is a library that allows you to easily integrate auth using Azure
1111
The React AAD MSAL library provides the following features:
1212

1313
* Login using Azure Active Directory
14-
- create your own function that handles how login (using this AzureAD component) is trigger in your react app
14+
- create your own function that handles how login (using this AzureAD component) is triggered in your react app
1515
- create your own function that handles the login success. The AzureAD library will call this function when login is complete to pass back the user info.
1616
* Logout callback
17-
- create your own function to handle how logout (using this AzureAD component) is trigger in your react app
17+
- create your own function to handle how logout (using this AzureAD component) is triggered in your react app
1818
* Optional use of redux store containing the token and user information returned from Active Directory
1919

2020
## Getting Started //TODO
@@ -75,7 +75,6 @@ Find the assignment for ClientID and replace the value with the Application ID f
7575
| `authority` | **[Optional]** A string representing your Azure Active Directory application policy. Include if you are trying to authenticate against your Azure Active Directory application. If you're using a B2C AAD, it is usually in the format of: `https://login.microsoftonline.com/tfp/<your-tenant-name>.onmicrosoft.com/<your-sign-in-sign-up-policy>` |
7676
| `type` | **[Optional]** `LoginType.Popup`. Popup is currently the only type available; redirect is currently buggy and disabled. |
7777
| `reduxStore` | **[Optional]** If you want to use redux for auth, you can provide a redux store which the AzureAD component will dispatch a `AAD_LOGIN_SUCCESS` action, as well as a `payload` containing `IUserInfo` |
78-
| Child Component | It is recommended that you provide a child component to the AzureAD component, this will be rendered when login is successful |
7978

8079
## Login
8180
To login, first create a callback function for the AzureAD component to consume. This function will be called when the component loads, and it will pass in the function to be called when the user wants to login. In this case, we create a button that will log the user in.

0 commit comments

Comments
 (0)