Collection of theme-ui and external components.
created:3/15/2021
updated:3/15/2021
source lines:129
comments %:19

GithubAvatar

avatar to be used in an AvatarList container

Component

import { GithubAvatar } from '@component-controls/components';

Overview

({
size,
overlap,
username,
useremail,
}) => {
return (
<GithubAvatar
size={size}
overlap={overlap}
username={username}
useremail={useremail}
/>
);
}

Properties

Name
Description
Default
Controls
username

user name

string
-
useremail

optional user email to link to gravatar

string
-
tooltip

on hover profile box

ReactNode
-
overlap

overlap % of the avatars in a list

number
0.4
size

size in pixels

number
48
fixedSize

whether to fix the size of the avataro on hover

boolean
true
githubAccessToken

to increase access rate for github user profile info

string
-

External dependencies

package
imports
peer
LocationIcon
react
^17.0.1
ReactNodeFC
*
theme-ui
^0.6.0-alpha.7
jsxBoxPropsAvatar

Internal dependencies

file
imports
"../Value"
"../Link"
"../Popover"
"./useGithubProfile"
useGithubProfile

Component JSX