gravatar-ui/com.gravatar.ui.components.atomic

Package-level declarations

Types

LocalIcon

enum LocalIcon : Enum<LocalIcon>

LocalIcon is a predefined list of social media icons that can be used in the SocialIcon composable.

SocialMedia

class SocialMedia(val url: URL, val name: String, val iconUrl: URL? = null, val icon: LocalIcon? = null)

SocialMedia is a data class that represents a social media account that Gravatar users can add to their profiles.

Functions

AboutMe

@Composable

fun AboutMe(profile: Profile, modifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.bodyMedium, content: @Composable (String, Modifier) -> Unit = { userInfo, contentModifier -> AboutMeDefaultContent(userInfo, textStyle, contentModifier) })

@Composable

fun AboutMe(state: ComponentState<Profile>, modifier: Modifier = Modifier, skeletonModifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.bodyMedium, content: @Composable (String, Modifier) -> Unit = { userInfo, contentModifier -> AboutMeDefaultContent(userInfo, textStyle, contentModifier) })

AboutMe is a composable that displays a user's about me description.

Avatar

@Composable

fun Avatar(state: ComponentState<String>, size: Dp, modifier: Modifier = Modifier)

@Composable

fun Avatar(profile: Profile, size: Dp, modifier: Modifier = Modifier, avatarQueryOptions: AvatarQueryOptions? = null, forceRefresh: Boolean = false)

@Composable

fun Avatar(state: ComponentState<Profile>, size: Dp, modifier: Modifier = Modifier, avatarQueryOptions: AvatarQueryOptions? = null, forceRefresh: Boolean = false)

Avatar is a composable that displays a user's avatar.

@Composable

fun Avatar(email: Email, size: Dp, modifier: Modifier = Modifier, avatarQueryOptions: AvatarQueryOptions? = null, cacheBuster: String? = null)

Atomic Avatar composable that displays a user's avatar that is generated from the user's email address. A skeleton overlay will be shown while loading the image.

DisplayName

@Composable

fun DisplayName(profile: Profile, modifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.headlineSmall.copy(fontWeight = FontWeight.Bold))

DisplayName is a composable that displays the user's display name.

@Composable

fun DisplayName(state: ComponentState<Profile>, modifier: Modifier = Modifier, skeletonModifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.headlineSmall.copy(fontWeight = FontWeight.Bold))

DisplayName is a composable that displays the user's display name or a loading skeleton.

Location

@Composable

fun Location(profile: Profile, modifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.bodyMedium.copy(color = MaterialTheme.colorScheme.outline), content: @Composable (String, Modifier) -> Unit = { location, contentModifier -> LocationDefaultContent(location, textStyle, contentModifier) })

Location is a composable that displays a user's location in text format. The user's location is displayed in a text format. If the location is too long, it will be truncated

@Composable

fun Location(state: ComponentState<Profile>, modifier: Modifier = Modifier, skeletonModifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.bodyMedium.copy(color = MaterialTheme.colorScheme.outline), content: @Composable (String, Modifier) -> Unit = { location, contentModifier -> LocationDefaultContent(location, textStyle, contentModifier) })

Location is a composable that displays a user's location in text format or a loading skeleton. The user's location is displayed in a text format. If the location is too long, it will be truncated

SocialIcon

@Composable

fun SocialIcon(media: SocialMedia, modifier: Modifier = Modifier)

SocialIcon is a composable that displays a clickable icon for a social media account. The link will navigate to the Gravatar user's profile on the social media platform.

SocialIconRow

@Composable

fun SocialIconRow(profile: Profile, modifier: Modifier = Modifier, maxIcons: Int = 4)

@Composable

fun SocialIconRow(state: ComponentState<Profile>, modifier: Modifier = Modifier, maxIcons: Int = 4)

@Composable

fun SocialIconRow(socialMedia: List<SocialMedia>, modifier: Modifier = Modifier, maxIcons: Int = 4)

SocialIconRow is a composable that displays a row of clickable SocialIcon.

UserInfo

@Composable

fun UserInfo(profile: Profile, modifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.bodyMedium.copy(color = MaterialTheme.colorScheme.outline), content: @Composable (String, Modifier) -> Unit = { userInfo, contentModifier -> UserInfoDefaultContent(userInfo, textStyle, contentModifier) })

@Composable

fun UserInfo(state: ComponentState<Profile>, modifier: Modifier = Modifier, skeletonModifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.bodyMedium.copy(color = MaterialTheme.colorScheme.outline), content: @Composable (String, Modifier) -> Unit = { userInfo, contentModifier -> UserInfoDefaultContent(userInfo, textStyle, contentModifier) })

UserInfo is a composable that displays a user's information in a formatted way. The user's information includes their company, job title, pronunciation, pronouns, and current location when available.

ViewProfileButton

@Composable

fun ViewProfileButton(profile: Profile, modifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.titleSmall.copy(color = MaterialTheme.colorScheme.onBackground), inlineContent: @Composable (String) -> Unit? = { DefaultInlineContent(textStyle.color) })

@Composable

fun ViewProfileButton(profile: Profile, modifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.titleSmall.copy(color = MaterialTheme.colorScheme.onBackground), buttonText: String = defaultViewProfileButtonText(), inlineContent: @Composable (String) -> Unit? = { DefaultInlineContent(textStyle.color) })

ViewProfileButton is a composable that displays a button to view a user's profile.

@Composable

fun ViewProfileButton(state: ComponentState<Profile>, modifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.titleSmall.copy(color = MaterialTheme.colorScheme.onBackground), inlineContent: @Composable (String) -> Unit? = { DefaultInlineContent(textStyle.color) })

ViewProfileButton is a composable that displays a button to view a user's profile or it's loading state.