-
Notifications
You must be signed in to change notification settings - Fork 889
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.
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
Open
swolfand
wants to merge
18
commits into
main
Choose a base branch
from
sam/mobile-325-android-authview-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+590
−228
Open
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
8b632b9
start adding clerk theme doc
swolfand ee9c056
Ready to add UserProfile
swolfand f4af1cd
Ready to add user profile view documentation
swolfand d5f5109
Add user profile view
swolfand 3786cfc
add images
swolfand a4e305a
delete android quickstart
swolfand 88d022c
removed ios by mistake
swolfand 914e48f
change incorrect view reference
swolfand 1f2e990
update account portal
swolfand 67bc3ab
update user button to reference correct view
swolfand 29eb31b
update image name
swolfand 465c1fc
replaced image
swolfand 9619e03
update typography
swolfand 584e772
docs review
SarahSoutoul 9ffd76f
docs review
SarahSoutoul 18e968d
Merge branch 'main' into sam/mobile-325-android-authview-guide
SarahSoutoul 63d0add
Add images
SarahSoutoul ac4b221
Linting
SarahSoutoul File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| <Properties> | ||
| - `primary` | ||
| - `Color` | ||
|
|
||
| The primary color used throughout the views. | ||
|
|
||
| --- | ||
|
|
||
| - `background` | ||
| - `Color` | ||
|
|
||
| The background color for containers. | ||
|
|
||
| --- | ||
|
|
||
| - `input` | ||
| - `Color` | ||
|
|
||
| The background color used for input fields. | ||
|
|
||
| --- | ||
|
|
||
| - `danger` | ||
| - `Color` | ||
|
|
||
| The color used for error states. | ||
|
|
||
| --- | ||
|
|
||
| - `success` | ||
| - `Color` | ||
|
|
||
| The color used for success states. | ||
|
|
||
| --- | ||
|
|
||
| - `warning` | ||
| - `Color` | ||
|
|
||
| The color used for warning states. | ||
|
|
||
| --- | ||
|
|
||
| - `foreground` | ||
| - `Color` | ||
|
|
||
| The color used for text. | ||
|
|
||
| --- | ||
|
|
||
| - `mutedForeground` | ||
| - `Color` | ||
|
|
||
| The color used for secondary text. | ||
|
|
||
| --- | ||
|
|
||
| - `primaryForeground` | ||
| - `Color` | ||
|
|
||
| The color used for text on the primary background. | ||
|
|
||
| --- | ||
|
|
||
| - `inputForeground` | ||
| - `Color` | ||
|
|
||
| The color used for text in input fields. | ||
|
|
||
| --- | ||
|
|
||
| - `neutral` | ||
| - `Color` | ||
|
|
||
| The color that will be used to generate the neutral shades the views use. | ||
|
|
||
| --- | ||
|
|
||
| - `ring` | ||
| - `Color` | ||
|
|
||
| The color of the ring when an interactive element is focused. | ||
|
|
||
| --- | ||
|
|
||
| - `muted` | ||
| - `Color` | ||
|
|
||
| The color used for muted backgrounds. | ||
|
|
||
| --- | ||
|
|
||
| - `shadow` | ||
| - `Color` | ||
|
|
||
| The base shadow color used in the views. | ||
|
|
||
| --- | ||
|
|
||
| - `border` | ||
| - `Color` | ||
|
|
||
| The base border color used in the views. | ||
| </Properties> |
2 changes: 1 addition & 1 deletion
2
docs/_partials/ios/customization.mdx → docs/_partials/views/customization.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| To learn how to customize Clerk iOS views, see the [dedicated guide](/docs/guides/customizing-clerk/clerk-theme). | ||
| To learn how to customize Clerk views, see the [dedicated guide](/docs/guides/customizing-clerk/clerk-theme). | ||
|
|
||
| If Clerk's prebuilt views don't meet your specific needs or if you require more control over the logic, you can rebuild the existing Clerk flows using the Clerk API. For more information, see the [custom flow guides](/docs/guides/development/custom-flows/overview). |
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| --- | ||
| title: '`ClerkTheme`' | ||
| description: Utilize Clerk's ClerkTheme to adjust the general styles of the Android views, like colors, fonts, and design properties. | ||
| sdk: android | ||
| --- | ||
|
|
||
| The `ClerkTheme` is used to customize the appearance of Clerk Android views by adjusting colors, fonts, and design properties. It provides a comprehensive theming system that allows you to create a consistent visual experience across all Clerk views. | ||
|
|
||
| ## Structure | ||
|
|
||
| `ClerkTheme` consists of five main properties: | ||
|
|
||
| - **`colors`** - Color properties for various UI elements across light and dark modes. | ||
| - **`lightColors`** - Optional overrides that only apply when the system is in light mode. These will default to the `colors` property if not provided. | ||
| - **`darkColors`** - Optional overrides that only apply when the system is in dark mode. These will default to the `colors` property if not provided. | ||
| - **`typography`** - Font and typography properties for different text styles. | ||
| - **`design`** - Design properties like border radius. | ||
|
|
||
| ## Colors | ||
|
|
||
| The `colors`,`lightColors`, and `darkColors` properties contain the following color options: | ||
|
|
||
| <Include src="_partials/views/clerk-theme-colors-property" /> | ||
|
|
||
| ## Fonts | ||
|
|
||
| The `typography` property contains the following font options based on Android Dynamic Type: | ||
|
|
||
| <Properties> | ||
| - `displaySmall` | ||
| - `TextStyle` | ||
|
|
||
| --- | ||
|
|
||
| - `headlineLarge` | ||
| - `TextStyle` | ||
|
|
||
| --- | ||
|
|
||
| - `headlineMedium` | ||
| - `TextStyle` | ||
|
|
||
| --- | ||
|
|
||
| - `titleMedium` | ||
| - `TextStyle` | ||
|
|
||
| --- | ||
|
|
||
| - `titleSmall` | ||
| - `TextStyle` | ||
|
|
||
| --- | ||
|
|
||
| - `bodyLarge` | ||
| - `TextStyle` | ||
|
|
||
| --- | ||
|
|
||
| - `bodyMedium` | ||
| - `TextStyle` | ||
|
|
||
| --- | ||
|
|
||
| - `bodySmall` | ||
| - `TextStyle` | ||
|
|
||
| --- | ||
|
|
||
| - `labelMedium` | ||
| - `TextStyle` | ||
|
|
||
| --- | ||
|
|
||
| - `labelSmall` | ||
| - `TextStyle` | ||
| </Properties> | ||
|
|
||
| ## Design | ||
|
|
||
| The `design` property contains the following design options: | ||
|
|
||
| <Properties> | ||
| - `borderRadius` | ||
| - `Dp` | ||
|
|
||
| The border radius used throughout the views. By default, this is set to `8.0`. | ||
| </Properties> | ||
|
|
||
| ## Usage | ||
|
|
||
| You can customize Clerk Android views by creating a `ClerkTheme` and applying it to Clerk's `customTheme` setter. | ||
|
|
||
| ### Apply a custom theme to all Clerk views | ||
|
|
||
| To customize all Clerk views in your app, create a `ClerkTheme` and apply it where you initialize the Clerk SDK. | ||
|
|
||
| ```kotlin | ||
| import android.app.Application | ||
| import androidx.compose.ui.graphics.Color | ||
| import androidx.compose.ui.unit.dp | ||
| import com.clerk.api.Clerk | ||
| import com.clerk.api.ui.ClerkColors | ||
| import com.clerk.api.ui.ClerkDesign | ||
| import com.clerk.api.ui.ClerkTheme | ||
|
|
||
| class WorkbenchApplication : Application() { | ||
|
|
||
| override fun onCreate() { | ||
| super.onCreate() | ||
| val theme = ClerkTheme( | ||
| colors = ClerkColors(primary = Color.Black), | ||
| design = ClerkDesign(borderRadius = 24.dp), | ||
| typography = ClerkTypographyDefaults.displaySmall.copy(fontSize = 24.sp) | ||
| ) | ||
|
|
||
| Clerk.initialize(this, "YOUR_PUBLIC_KEY", theme = theme) | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| ### Apply a theme to specific views | ||
|
|
||
| You can apply a theme to specific Clerk views by passing a `ClerkTheme` to any Clerk UI component. The theme used here will apply to all children of this view. | ||
|
|
||
| ```kotlin | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.compose.ui.graphics.Color | ||
| import androidx.compose.ui.unit.dp | ||
| import androidx.compose.ui.Alignment | ||
| import androidx.compose.foundation.layout.Box | ||
| import androidx.compose.foundation.layout.fillMaxSize | ||
| import androidx.compose.foundation.background | ||
| import com.clerk.api.Clerk | ||
| import com.clerk.api.ui.ClerkColors | ||
| import com.clerk.api.ui.ClerkDesign | ||
| import com.clerk.api.ui.ClerkTheme | ||
| import com.clerk.api.ui.ClerkTypographyDefaults | ||
| import com.clerk.api.ui.UserButton | ||
| import com.clerk.api.ui.AuthView | ||
|
|
||
| @Composable | ||
| fun HomeScreen { | ||
| val user by Clerk.userFlow.collecAsStateWithLifecycle() | ||
| Box( | ||
| modifier = Modifier.fillMaxSize().background(color = Color(0xFFF9F9F9)), | ||
| contentAlignment = Alignment.Center, | ||
| ) { | ||
| if (user != null) { | ||
| UserButton() | ||
| } else { | ||
| AuthView(clerkTheme = ClerkTheme(colors = ClerkColors(primary = Color.Blue))) | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Custom fonts | ||
|
|
||
| You can customize fonts by modifying the `typography` property of the `ClerkTheme`. | ||
|
|
||
| #### Using a font family name | ||
|
|
||
| ```kotlin | ||
| AuthView(clerkTheme = ClerkTheme(typography = ClerkTypography(displaySmall = ClerkTypographyDefaults.displaySmall.copy(fontSize = 24.sp)))) | ||
| ``` | ||
|
|
||
| ## Light and Dark mode support | ||
|
|
||
| Clerk Android views automatically support both light and dark mode appearance, adapting seamlessly to the user's system preferences. | ||
|
|
||
| <div style={{ display: 'flex', gap: '20px', alignItems: 'flex-start' }}> | ||
| {{ style: { maxWidth: '230px' } }} | ||
| {{ style: { maxWidth: '230px' } }} | ||
| </div> | ||
|
|
||
| If Clerk's prebuilt theming doesn't meet your specific needs, you can create completely custom authentication flows using the Clerk API. For more information, see the [custom flow guides](/docs/guides/development/custom-flows/overview). | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.