Skip to content

Add docs for Android components #2848

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

Jump to bottom
Merged
swolfand merged 37 commits into from
Dec 11, 2025
Merged

Add docs for Android components #2848

swolfand merged 37 commits into from
Dec 11, 2025

Conversation

@swolfand
Copy link
Contributor

@swolfand swolfand commented Dec 1, 2025 •
edited by alexisintech
Loading

🔎 Previews:

This pull request adds comprehensive documentation for Clerk's Android UI components and customization options. It introduces reference pages for the main Clerk Android views, explains how to customize them using the new ClerkTheme system, and clarifies installation and usage patterns for the Clerk Android SDK. The changes are grouped into new documentation for Android views, detailed theming and customization guides, and updates to component reference listings.

Android Views Documentation

  • Added new reference pages for Clerk Android views: AuthView, UserButton, and UserProfileView, including usage examples, parameter descriptions, and customization instructions. [1] [2] [3]
  • Introduced an overview page for Clerk Android views, listing available components and providing installation instructions for the SDK packages.

Theming and Customization

  • Added a dedicated guide for customizing Clerk Android views using the ClerkTheme, detailing color, typography, and design properties, as well as usage examples for global and per-view theming.
  • Included a partial describing how to rebuild Clerk flows for advanced customization and linking to custom flow guides.

Component Reference Updates

  • Updated the main component reference to remove android from the SDK list, ensuring correct categorization and navigation.

@swolfand swolfand requested a review from a team as a code owner December 1, 2025 21:32
@vercel
Copy link

vercel bot commented Dec 1, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
clerk-docs Ready Ready Preview Dec 11, 2025 8:45pm

@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

⚠️ Changes found in the following quickstarts:

  • android.mdx

⚠️ Please update the corresponding quickstarts in the Dashboard

@swolfand swolfand force-pushed the sam/mobile-325-android-authview-guide branch from 6620a5b to 169ed35 Compare December 1, 2025 21:35
@swolfand swolfand marked this pull request as draft December 1, 2025 21:35
@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

⚠️ Changes found in the following quickstarts:

  • android.mdx

⚠️ Please update the corresponding quickstarts in the Dashboard

@swolfand swolfand force-pushed the sam/mobile-325-android-authview-guide branch from 169ed35 to 097ff9e Compare December 1, 2025 22:54
@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

⚠️ Changes found in the following quickstarts:

  • android.mdx

⚠️ Please update the corresponding quickstarts in the Dashboard

@swolfand swolfand force-pushed the sam/mobile-325-android-authview-guide branch from 097ff9e to d5f5109 Compare December 2, 2025 23:33
@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2025

⚠️ Changes found in the following quickstarts:

  • android.mdx

⚠️ Please update the corresponding quickstarts in the Dashboard

@SarahSoutoul SarahSoutoul mentioned this pull request Dec 2, 2025
Merged
11 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2025

⚠️ Changes found in the following quickstarts:

  • android.mdx

⚠️ Please update the corresponding quickstarts in the Dashboard

SarahSoutoul
SarahSoutoul reviewed Dec 2, 2025
View reviewed changes
SarahSoutoul
SarahSoutoul reviewed Dec 2, 2025
View reviewed changes
SarahSoutoul
SarahSoutoul reviewed Dec 3, 2025
View reviewed changes
SarahSoutoul
SarahSoutoul reviewed Dec 3, 2025
View reviewed changes
SarahSoutoul
SarahSoutoul reviewed Dec 3, 2025
View reviewed changes
SarahSoutoul
SarahSoutoul reviewed Dec 3, 2025
View reviewed changes
SarahSoutoul
SarahSoutoul reviewed Dec 3, 2025
View reviewed changes
manovotny
manovotny reviewed Dec 9, 2025
View reviewed changes
Copy link
Contributor

@manovotny manovotny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work @swolfand and @SarahSoutoul!

Just a couple of small questions/comments.

SarahSoutoul and others added 3 commits December 9, 2025 10:50
@SarahSoutoul @manovotny
Update docs/guides/customizing-clerk/clerk-theme.android.mdx
9016eec 
Co-authored-by: Michael Novotny <manovotny@gmail.com>
@SarahSoutoul @manovotny
Apply suggestions from code review
0b68188 
Co-authored-by: Michael Novotny <manovotny@gmail.com>
@SarahSoutoul
Full-screen to Fullscreen
4973383
@SarahSoutoul
Copy link
Contributor

SarahSoutoul commented Dec 9, 2025

@swolfand following our meeting today, I've submitted a last commit with fixes: docs review pt2. Have a look and let me know if anything doesn't look right.

@swolfand
Copy link
Contributor Author

swolfand commented Dec 9, 2025

@SarahSoutoul looks great to me!

@SarahSoutoul
Copy link
Contributor

SarahSoutoul commented Dec 9, 2025

@manovotny have committed your suggestions and pushed some last commits after a call with Sam. I'm good to approve this, and it will only be merged after the actual Android SDK changes have been released. But be good to have your approval too on this in case I missed anything.

manovotny
manovotny reviewed Dec 9, 2025
View reviewed changes
SarahSoutoul and others added 2 commits December 9, 2025 17:16
manovotny
manovotny approved these changes Dec 11, 2025
View reviewed changes
Copy link
Contributor

@manovotny manovotny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@alexisintech
Copy link
Member

alexisintech commented Dec 11, 2025

also LGTM! didn't test the code as i believe sarah did this with sam - but everything looks like perfection 😸💖

@SarahSoutoul
Copy link
Contributor

SarahSoutoul commented Dec 11, 2025

call with Sam. I'm good to approve this, and it will only be merged after the actual Android SDK changes have been released. But be good to have your approval too on this in case I missed anything.

Yes we tested everything together on a call!

@swolfand swolfand merged commit 35b6c80 into main Dec 11, 2025
7 checks passed
@swolfand swolfand deleted the sam/mobile-325-android-authview-guide branch December 11, 2025 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@manovotny manovotny manovotny approved these changes

@SarahSoutoul SarahSoutoul SarahSoutoul approved these changes

Assignees

@SarahSoutoul SarahSoutoul

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@swolfand @SarahSoutoul @alexisintech @manovotny