feat: add docs for ory elements v1.2#2361
Merged
Merged
Conversation
jonas-jonas
requested review from
aeneasr,
piotrmsc,
vinckr and
zepatrik
as code owners
vinckr
requested changes
Nov 24, 2025
Co-authored-by: Vincent <vincent@ory.sh>
|
Warning Review limit reached
More reviews will be available in 2 minutes and 38 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (2)
📒 Files selected for processing (44)
📝 WalkthroughWalkthroughThis PR expands the Ory Elements React reference documentation by adding type aliases for discriminated UI node variants, component prop types with input element attributes, type-guard helper functions, a code-resend hook, and updated component implementations with deprecation guidance. The sidebar configuration is updated to expose the expanded API surface. ChangesType and Function Reference Documentation
🎯 3 (Moderate) | ⏱️ ~20 minutes
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@docs/elements/reference/`@ory/elements-react/theme/functions/DefaultButtonSocial.md:
- Line 14: The documentation for DefaultButtonSocial incorrectly mentions an
optional label via a now-removed prop; update the text in DefaultButtonSocial
(the component docs) to remove any reference to a `showLabel` prop and instead
describe the current behavior (renders a button with a logo and optional label
only if the current props support it, or simply "renders a button with a logo")
so the intro matches the actual prop contract of DefaultButtonSocial.
In `@docs/elements/reference/`@ory/elements-react/variables/Node.md:
- Around line 4-12: The Node declaration's parentheses are misplaced so the type
is parsed as a function returning "ReactNode & { ... }" instead of a callable
component intersected with static renderer properties; update the type of the
Node constant to be an intersection between the function signature and the
renderer-object type by wrapping the function type in parentheses, i.e. change
the shape from "const Node: (__namedParameters: NodeProps) => ReactNode & {
Button: ..., Checkbox: ..., ConsentCheckbox: ..., Image: ..., Input: ...,
SsoButton: ..., Text: ... }" to "const Node: (({...}: NodeProps) => ReactNode) &
{ Button: ..., Checkbox: ..., ConsentCheckbox: ..., Image: ..., Input: ...,
SsoButton: ..., Text: ... }" so Button, Checkbox, ConsentCheckbox, Image, Input,
SsoButton and Text are static properties on the callable Node.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 40dd2a85-c760-4ead-ad93-56a1593106a3
⛔ Files ignored due to path filters (1)
docs/elements/guides/05_upgrading.mdxis excluded by!**/*.mdx
📒 Files selected for processing (49)
docs/elements/reference/@ory/elements-react/functions/OryCardValidationMessages.mddocs/elements/reference/@ory/elements-react/functions/OrySettingsFormSection.mddocs/elements/reference/@ory/elements-react/functions/isUiNodeAnchor.mddocs/elements/reference/@ory/elements-react/functions/isUiNodeDiv.mddocs/elements/reference/@ory/elements-react/functions/isUiNodeImage.mddocs/elements/reference/@ory/elements-react/functions/isUiNodeInput.mddocs/elements/reference/@ory/elements-react/functions/isUiNodeScript.mddocs/elements/reference/@ory/elements-react/functions/isUiNodeText.mddocs/elements/reference/@ory/elements-react/functions/resolvePlaceholder.mddocs/elements/reference/@ory/elements-react/functions/useResendCode.mddocs/elements/reference/@ory/elements-react/index.mddocs/elements/reference/@ory/elements-react/theme/functions/DefaultButtonSocial.mddocs/elements/reference/@ory/elements-react/theme/functions/DefaultCard.mddocs/elements/reference/@ory/elements-react/theme/functions/Settings.mddocs/elements/reference/@ory/elements-react/theme/index.mddocs/elements/reference/@ory/elements-react/type-aliases/NodeProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryCardAuthMethodListItemProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryFlowComponents.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeButtonButtonProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeButtonProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeCheckboxInputProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeCheckboxProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeConsentScopeCheckboxProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeImageProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeInputInputProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeInputProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeLabelProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeSettingsButton.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeSsoButtonProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OryNodeTextProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OrySettingsPasskeyProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OrySettingsRecoveryCodesProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OrySettingsSsoProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OrySettingsTotpProps.mddocs/elements/reference/@ory/elements-react/type-aliases/OrySettingsWebauthnProps.mddocs/elements/reference/@ory/elements-react/type-aliases/UiNodeAnchor.mddocs/elements/reference/@ory/elements-react/type-aliases/UiNodeDiv.mddocs/elements/reference/@ory/elements-react/type-aliases/UiNodeFixed.mddocs/elements/reference/@ory/elements-react/type-aliases/UiNodeImage.mddocs/elements/reference/@ory/elements-react/type-aliases/UiNodeInput.mddocs/elements/reference/@ory/elements-react/type-aliases/UiNodeScript.mddocs/elements/reference/@ory/elements-react/type-aliases/UiNodeText.mddocs/elements/reference/@ory/elements-react/variables/Node.mddocs/elements/reference/@ory/nextjs/app/index.mddocs/elements/reference/@ory/nextjs/middleware/index.mddocs/elements/reference/@ory/nextjs/pages/index.mddocs/elements/reference/index.mddocs/elements/reference/typedoc-sidebar.tssrc/sidebar-old.ts
💤 Files with no reviewable changes (4)
- docs/elements/reference/@ory/nextjs/middleware/index.md
- docs/elements/reference/@ory/nextjs/app/index.md
- docs/elements/reference/@ory/elements-react/theme/index.md
- docs/elements/reference/@ory/nextjs/pages/index.md
unatasha8
pushed a commit
that referenced
this pull request
Jun 11, 2026
* feat: add docs for ory elements v1.2 * Apply suggestions from code review Co-authored-by: Vincent <vincent@ory.sh> * chore: u * chore: u * chore: regnerate type docs * chore: use ProjectConfiguration * chore: u --------- Co-authored-by: Vincent <vincent@ory.sh>
wassimoo
added a commit
that referenced
this pull request
Jun 11, 2026
* docs: adds integration section to top navbar * feat: add community integration stubs under docs/integrates-with Adds 90 community-contributed integration stubs from ory/integrates, organized by vendor category under docs/integrates-with/<category>/<vendor>.mdx, and wires them into sidebars-integrates.ts (27 category sections). For pages that overlap with an existing source-of-truth doc in this repo (Mailchimp via Actions, GitHub sign-in, kratos SMTP and SMS courier pages), the new page leads with a "Primary documentation" admonition linking to the canonical page; see docs/integrates-with/_DUPLICATES.md for the inventory. * docs: remove test files * feat: add generated index links to sidebar categories * docs: fold community email/SMS provider snippets into kratos courier pages Merge the draft provider snippets that were staged under docs/integrates-with into the canonical Ory courier pages: - 01_sending-emails-smtp.mdx: add Brevo, Mailchimp Transactional (Mandrill), and SparkPost as first-class provider entries alongside Sendgrid/Mailgun/SES/Postmark. - 10_sending-sms.mdx: add a Provider examples section with Twilio, MessageBird, Plivo, Sinch, Vonage, and WhatsApp Business request_config examples (the page previously only showed Twilio inline). Removes the now-folded snippet drafts and the _DUPLICATES.md inventory, since the overlaps they tracked are now resolved in-page. * docs: added redirects * docs: add Terraform integration page under integrates-with/iac-devops Add a proper Terraform page for the official ory/ory provider, which had no page in this repo (its canonical docs are external, on the Terraform/OpenTofu registries). Repoint pulumi.mdx's three references from the ory/integrates GitHub URL to the new internal ./terraform.mdx, and add it to the IaC and DevOps sidebar category above Pulumi. * docs: reconcile integrates-with stubs that duplicate first-party pages Per the integrations-team handoff, collapse community stubs that duplicate existing first-party Ory docs: - SMS providers: delete the standalone messagebird/plivo/sinch/twilio/ vonage stubs (now folded into kratos/emails-sms/sending-sms) and drop them from the sidebar. Keep WhatsApp as its own page (custom courier handler, not a plain SMS provider) and point the SMS page's WhatsApp entry at it. - Mailchimp marketing: fold the marketing-audience flow into the existing actions/integrations/mailchimp page as a section (it already covers both subsystems) and delete the cdp-analytics/mailchimp and cdp-analytics/mailchimp-marketing duplicates. - Helm: add a thin integrates-with/iac-devops/helm pointer page with a rel=canonical to the existing hydra/self-hosted Helm chart guide, so the official charts are discoverable under IaC and DevOps without duplicating content. * chore: gitignore Claude Code local files (.claude/docs, worktrees, etc.) * docs: thin canonical-pointer stubs for social sign-in providers Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: thin canonical-pointer stubs for email and SMS providers * docs: thin stubs for enterprise SSO, generic protocols, and SCIM (per-deployment homes) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: thin stubs for Actions-backed integrations and yubikey * docs: full community pages for net-new integrations (README-sourced) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: reconcile existing integrates-with pages to thin-stub rule; dedupe salesforce/workday slugs * docs: wire the complete integration catalog into the integrates-with sidebar * docs: apply Ory voice/style pass to integrates-with catalog Apply the ory-docs-voice style guide across the integration catalog: convert telegraphic fragments and arrow-chains into complete second-person sentences, fix terminology (Ory Identities, sign in, self-service flows, set up, Admin API, full product names on first mention), and remove marketing fluff. Thin canonical-pointer stubs were largely already on-voice and left as-is. Preserved: frontmatter, <head> canonical links, admonition types/titles and their links, page types, all link targets/anchors, and the existing /docs/actions links (pending a separate docs-team decision). * fix: update oss docs (#2607) * docs: bump to 8dc0c20ab729fb27c8bf746ee192dbc2fe9b40a4 * fix: enhance dark mode styling for announcement banner (#2610) * chore(docs): update of OEL images (#2596) * chore: h1 policy (#2609) * docs: fix underscores (#2608) * docs: fix underscores * docs: added redirects * feat: document transient payload passthrough in elements (#2499) * feat: document transient payload passthrough in elements * chore: format * Apply suggestions from code review Co-authored-by: Jonas Hungershausen <jonas.hungershausen@gmail.com> * Apply suggestions from code review Co-authored-by: unatasha8 <una.cogavin@ory.sh> --------- Co-authored-by: unatasha8 <una.cogavin@ory.sh> * feat: add docs for client side events in elements (#2498) * feat: add docs for client side events in elements * Apply suggestions from code review Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: Jonas Hungershausen <jonas.hungershausen@gmail.com> * chore: format * chore: apply suggestion * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs: added docs for scim mapper now receiving identity (#2612) added docs for scim mapper now receiving identity * fix: makefile * chore: warnings about graceful token refresh * feat: add docs for ory elements v1.2 (#2361) * feat: add docs for ory elements v1.2 * Apply suggestions from code review Co-authored-by: Vincent <vincent@ory.sh> * chore: u * chore: u * chore: regnerate type docs * chore: use ProjectConfiguration * chore: u --------- Co-authored-by: Vincent <vincent@ory.sh> * docs: bump to 41024d0730ec0a14ca249c3ee393e1e328b5ec27 * chore(docs): update of OEL images (#2618) chore(docs): update OEL image tag * docs: document pausing event streams Add a "Pause and resume event streams" section to the live event streams guide covering how to pause/resume a stream from the Ory Console, how to create a stream as paused, and what happens to events while a stream is paused. Most importantly, it explains the buffering behavior: while paused, events keep accumulating and are retained for up to 7 days. Resuming within that window delivers the buffered backlog; events older than 7 days are permanently discarded. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * autogen: update license overview * docs: fix underscore in Learn more link * refactor: format integrates-with docs * fix: update navbar responsiveness breakpoints --------- Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: jhickmanit <jhickman.it@gmail.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Co-authored-by: Vincent <vincent@ory.sh> Co-authored-by: aeneasr <3372410+aeneasr@users.noreply.github.com> Co-authored-by: ory-bot <60093411+ory-bot@users.noreply.github.com> Co-authored-by: Jonas Hungershausen <jonas.hungershausen@ory.sh> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Deepak Prabhakara <deepak.prabhakara@ory.sh> Co-authored-by: Arne Luenser <arne.luenser@ory.sh>
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
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.
Related Issue or Design Document
Checklist
If this pull request addresses a security vulnerability,
I confirm that I got approval (please contact security@ory.sh) from the maintainers to push the changes.
Further comments
Summary by CodeRabbit
@ory/elements-react, including type aliases, helper functions, and component signatures.useResendCodehook.