Skip to content

fix(@nylas/react): correct Connect import paths in README #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nbarraclough merged 2 commits into from
Sep 1, 2026
Merged

fix(@nylas/react): correct Connect import paths in README #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e72ae39
fix(@nylas/react): correct Connect import paths in README
nbarraclough Sep 1, 2026
561a9ee
Merge branch 'main' into fix/react-readme-connect-imports
nbarraclough Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-react-readme-connect-imports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@nylas/react": patch
---

Fix the import path in the README's Connect examples. `useNylasConnect` and `NylasConnectButton` are only exported from the `@nylas/react/connect` subpath, so the snippets that imported them from `@nylas/react` could not resolve.
10 changes: 5 additions & 5 deletions packages/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ or yarn

- **Connect**
- `useNylasConnect`, `NylasConnectButton`
- Import from `@nylas/react` or `@nylas/react/connect`
- Import from `@nylas/react/connect`

## Getting Started

Expand Down Expand Up @@ -121,7 +121,7 @@ The `useNylasConnect` hook provides a simple way to add OAuth authentication to
### Basic Usage

```jsx
import { useNylasConnect } from '@nylas/react';
import { useNylasConnect } from "@nylas/react/connect";

function LoginButton() {
const { isConnected, connect, logout, grant, isLoading } = useNylasConnect({
Expand Down Expand Up @@ -204,7 +204,7 @@ The `NylasConnectButton` component provides a simple way to add email provider a
### Basic Usage

```jsx
import { NylasConnectButton } from "@nylas/react";
import { NylasConnectButton } from "@nylas/react/connect";

function App() {
return (
Expand All @@ -227,7 +227,7 @@ function App() {
For applications that use external identity providers (via JWKS), you can pass identity provider tokens during authentication:

```jsx
import { NylasConnectButton } from "@nylas/react";
import { NylasConnectButton } from "@nylas/react/connect";

function App() {
// Function to retrieve JWT token from your external identity provider
Expand Down Expand Up @@ -258,7 +258,7 @@ function App() {
For enhanced security, you can handle the OAuth code exchange on your backend:

```jsx
import { NylasConnectButton } from "@nylas/react";
import { NylasConnectButton } from "@nylas/react/connect";

function App() {
const handleCodeExchange = async (params) => {
Expand Down
Loading