remix-auth-notion
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

NotionStrategy

Allow users to login with Notion.

Setup your application at Notion integrations The integration should be setup as Public integration

Copy OAuth client ID and OAuth client secret to your NotionStrategy setup and setup the Redirect URI.

Notion requires that the redirect URI uses HTTPS. In development you can use a service like ngrok to be able to test the integration.

Supported runtimes

Runtime Has Support
Node.js
Cloudflare

How to use

let notionStrategy = new NotionStrategy(
  {
    clientID: "",
    clientSecret: "",
    callbackURL: "https://domain-name.com/auth/notion/callback",
  },
  async ({ accessToken, extraParams, profile }) => {
    return {
      accessToken,
      id: profile.id,
      name: profile.name,
    };
  }
);

authenticator.use(notionStrategy);

In routes/auth/notion.tsx

import { ActionFunction, LoaderFunction, redirect } from "remix";
import { authenticator } from "~/auth.server";

export let loader: LoaderFunction = () => redirect("/login");

export let action: ActionFunction = ({ request }) => {
  return authenticator.authenticate("notion", request);
};

In routes/auth/notion/callback.tsx

import { ActionFunction, LoaderFunction, redirect } from "remix";
import { authenticator } from "~/auth.server";

export let loader: LoaderFunction = async ({ request }) => {
  return authenticator.authenticate("notion", request, {
    successRedirect: "/success",
    failureRedirect: "/login",
  });
};

Now you can direct the user to login by making a Form with POST to /auth/notion

import { Form } from "remix";

export default function Index() {
  return (
    <Form action="/auth/notion" method="post">
      <button>Login with Notion</button>
    </Form>
  );
}

Package Sidebar

Install

npm i remix-auth-notion

Weekly Downloads

2

Version

1.1.1

License

MIT

Unpacked Size

13.4 kB

Total Files

5

Last publish

Collaborators

  • juhanakristian