docs: correct the @nylas/react description in the root README - #96
Merged
Conversation
The root README advertised "Pre-built UI components for email, calendar, and contacts". The package ships none of those: - Email UI: none. The three email-named exports (NylasConfirmationEmail, NylasDisableEmails, NylasReminderEmails) are booking-notification settings, not inbox, message or composer UI. - Contacts UI: none at all. - Calendar: NylasCalendarPicker and NylasConnectedCalendars exist, but serve calendar connection and selection for scheduling rather than a general calendar UI. Of the 59 Nylas* components exported from elements/components.ts, essentially all are Scheduler and booking building blocks. The package's own README already describes itself accurately as "React components for Nylas Scheduler"; only the root README disagreed. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
AaronDDM
approved these changes
Sep 1, 2026
AaronDDM
left a comment
AaronDDM
left a comment
Collaborator
There was a problem hiding this comment.
Good afternoon!
Verified against packages/react/src/elements/components.ts. There's no inbox, message list, thread view, or composer, and nothing for contacts at all. The email-named exports are booking notification settings, and the calendar ones are for connection/selection rather than a general calendar UI. New wording matches what ships, and it now agrees with the package's own README.
Agreed on skipping the changeset — the root README isn't published to npm.
Approving.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The root README advertises, for
@nylas/react:The package ships none of those. This replaces that bullet with "Pre-built Scheduler and booking UI components".
Evidence
packages/react/src/elements/components.tsexports 134 identifiers — 59Nylas*components plus icons and form primitives. Categorising the 59:NylasConfirmationEmail,NylasDisableEmails,NylasReminderEmails— booking-notification settings. No inbox, message list, thread view, or composer.NylasAdditionalParticipantsis booking participants.)NylasCalendarPicker,NylasConnectedCalendars,NylasEventCalendarexist, but serve calendar connection/selection for scheduling — not a general calendar UI.What's actually there:
NylasSchedulerEditor,NylasScheduling,NylasSchedulingMethod, and ~53 Scheduler/booking building blocks (NylasAvailabilityPicker,NylasBookingForm,NylasBufferTime,NylasCancellationPolicy,NylasTimeslotPicker, …), plusNylasNotetakerConfig, and the Connect hook and button.Notably, the package's own README already gets this right —
packages/react/README.md:3reads "React components for Nylas Scheduler". Only the root README disagreed, so this aligns the two.The other bullets check out and are untouched: "Works with React 18 and 19" matches
peerDependencies(^18 || ^19), and the modular exports claim matches the./elements,./connect,./utilssubpaths.One-line change, no changeset — the root README is not published to npm.
🤖 Generated with Claude Code