React

To see a full example of using Passage in a React + Express.js application, please visit our sample app on GitHub. 
Importing and Using the Passage-Auth Custom Element
The easiest way to add authentication to a web frontend is with a Passage Auth custom element. First you'll need to install the passage-elements package from npm:
1
npm i --save @passageidentity/passage-elements
Copied!
Then import the package in the module where you intend to use the custom element
1
import '@passageidentity/passage-elements/passage-auth'
Copied!
Importing this script will register the Passage custom element for use in your React components. For more information about custom elements, refer to the online documentation.
It's then just a matter of embedding the <passage-auth> element into your component that will handle login. This is done in the example in frontend/src/views/Home.js:
1
<div className={styles.authContainer}>
2
  <passage-auth app-id={process.env.REACT_APP_PASSAGE_APP_ID}></passage-auth>
3
</div>
Copied!
Getting Authentication Status and User Information
After the user has logged in with Passage, you can check is a user's authentication token is valid and retrieve basic user information from Passage using the PassageUser class exported from @passageidentity/passage-elements/passage-user. This example wraps this functionality into a reusable react hook in useAuthStatus:
1
import { PassageUser } from '@passageidentity/passage-elements/passage-user';
2
...
3
useEffect(() => {
4
    let cancelRequest = false;
5
    new PassageUser().userInfo().then(userInfo=> {
6
...
Copied!
The PassageUser().authGuard() function can be used as a route guard in your application, but it should NOT be make authorization decisions when fetching data from an API server. Route guards provide a better user experience, but less security than using one of Passage's backend libraries. For applications using an API server, you must use one of the Passage backend SDKs to safely verify user authentication tokens.
Defining Callbacks
To define a callback on a Passage Element in React, you can attach a ref to the element and then set the callback on that ref in a useEffect(). An example is shown below.
1
import "@passageidentity/passage-elements/passage-auth";
2
import { useEffect, useRef } from "react";
3
​
4
function Home() {
5
    const ref = useRef();
6
​
7
    const beforeAuth = (email) =>{
8
        console.log(email);
9
        return true;
10
      }
11
​
12
    useEffect(() => {
13
        const {current} = ref;
14
        current.beforeAuth = beforeAuth;
15
        return () => {}
16
    });
17
​
18
    return (
19
        <passage-auth ref={ref} app-id={process.env.REACT_APP_PASSAGE_APP_ID}></passage-auth>
20
    );
21
}
22
​
23
export default Home;
Copied!
Learn more about the available callbacks here.

🧑‍💻 Passage for Web - Previous

Custom Logic with Callbacks

Next - Frontend Frameworks

Next.js

Last modified 2mo ago

Copy link

Contents

Importing and Using the Passage-Auth Custom Element

Getting Authentication Status and User Information

Defining Callbacks