JSPM

expo-auth-session

6.0.4-canary-20250304-0da3971
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 436998
  • Score
    100M100P100Q186342F
  • License MIT

Expo module for browser-based authentication

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (expo-auth-session) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    expo-auth-session

    AuthSession is the easiest way to implement web browser based authentication (for example, browser-based OAuth flows) to your app, built on top of expo-web-browser.

    API documentation

    Installation in managed Expo projects

    For managed Expo projects, please follow the installation instructions in the API documentation for the latest stable release.

    Installation in bare React Native projects

    For bare React Native projects, you must ensure that you have installed and configured the expo package before continuing.

    Add the package to your npm dependencies

    npx expo install expo-auth-session expo-crypto

    Configuration

    To use this module, you need to set up React Native deep linking in your application. For more information, check out React Native documentation.

    Add support for React Native deep linking

    • Android:

      Add intent filter and set the launchMode of your MainActivity to singleTask in AndroidManifest.yml:

      <activity
          android:name=".MainActivity"
          android:launchMode="singleTask">
          <intent-filter>
              <action android:name="android.intent.action.VIEW" />
              <category android:name="android.intent.category.DEFAULT" />
              <category android:name="android.intent.category.BROWSABLE" />
              <!-- Accepts URIs that begin with "example://gizmos” -->
              <data android:scheme="example"
                  android:host="gizmos" />
          </intent-filter>

      For more information about the available configuration, check out Android documentation.

    • iOS:

      Add following lines to your AppDelegate.m:

      #import <React/RCTLinkingManager.h>
      
      // iOS 9.x or newer
      - (BOOL)application:(UIApplication *)application
                  openURL:(NSURL *)url
                  options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
      {
          return [RCTLinkingManager application:application openURL:url options:options];
      }
      
      // iOS 8.x or older
      - (BOOL)application:(UIApplication *)application
                  openURL:(NSURL *)url
        sourceApplication:(NSString *)sourceApplication
               annotation:(id)annotation
      {
          return [RCTLinkingManager application:application openURL:url
                          sourceApplication:sourceApplication annotation:annotation];
      }

      Add following lines to Info.plist:

      <dict>
          ...
          <key>CFBundleURLTypes</key>
          <array>
              <dict>
                  <key>CFBundleURLName</key>
                  <string>gizmos</string>
                  <key>CFBundleURLSchemes</key>
                  <array>
                      <string>example</string>
                  </array>
              </dict>
          </array>
      </dict>

    Contributing

    Contributions are very welcome! Please refer to guidelines described in the contributing guide.