Skip to main content

@learncard/react

Enumerations

Type Aliases

ButtonProps

Ƭ ButtonProps: Object

Type declaration

NameType
className?string
onClickMouseEventHandler<HTMLButtonElement>
text?string

Defined in

packages/react-learn-card/src/components/Button/Button.tsx:3


CircleIconProps

Ƭ CircleIconProps: Object

Type declaration

NameType
bgColor?string
borderColor?string
count?string | number
hideCount?boolean
iconSrc?string
innerPadding?string
onClick?() => void
size?string

Defined in

packages/react-learn-card/src/components/CircleIcon/CircleIcon.tsx:6


CircleSpinnerProps

Ƭ CircleSpinnerProps: Object

Type declaration

NameType
color?string
loadingState?CircleLoadingState
marginOffset?number
size?number
thickness?number

Defined in

packages/react-learn-card/src/components/Loading/CircleSpinner.tsx:8


CountCircleProps

Ƭ CountCircleProps: Object

Type declaration

NameType
bgColor?string
className?string
count?string | number
innerPadding?string
onClick?() => {}
size?string

Defined in

packages/react-learn-card/src/components/CircleIcon/CircleIcon.tsx:17


FlippyCardProps

Ƭ FlippyCardProps: Object

Type declaration

NameType
childrenReact.ReactChild[]

Defined in

packages/react-learn-card/src/components/FlippyCard/FlippyCard.tsx:3


LearnCardCreditCardBackFaceProps

Ƭ LearnCardCreditCardBackFaceProps: Object

Type declaration

NameTypeDescription
cardLearnCardCreditCardProps-
className?stringcustom className
userLearnCardCreditCardUserProps-

Defined in

packages/react-learn-card/src/components/LearnCardCreditCardBackFace/types.ts:1


LearnCardCreditCardFrontFaceProps

Ƭ LearnCardCreditCardFrontFaceProps: Object

Type declaration

NameTypeDescription
actionButtonText?stringaction button text Param Card" - set as default text.
className?stringcustom className
onClick?() => voidaction button click handler
qrCodeValue?stringqr code value
showActionButton?booleanshow or hide an action button Param Action button hidden by default.
userImage?stringuser image
userImageComponent?React.ReactNodecustom image component

Defined in

packages/react-learn-card/src/components/LearnCardCreditCardFrontFace/types.ts:1


LearnCardCreditCardProps

Ƭ LearnCardCreditCardProps: Object

Type declaration

NameTypeDescription
cardExpirationDatestringcard expiration date
cardIssueDate?stringcard issue date
cardNumberstringcard number
cardSecurityCode?stringcard security code

Defined in

packages/react-learn-card/src/components/LearnCardCreditCardBackFace/types.ts:24


LearnCardCreditCardUserProps

Ƭ LearnCardCreditCardUserProps: Object

Type declaration

NameTypeDescription
fullNamestringuser full name
username?stringunique user handle / username

Defined in

packages/react-learn-card/src/components/LearnCardCreditCardBackFace/types.ts:11


MiniVCThumbnailProps

Ƭ MiniVCThumbnailProps: Object

Type declaration

NameTypeDescription
badgeImage?stringbadge image
className?stringcustom className
createdAt?stringissue date
issuerImage?stringissuer image
onClick?() => void
title?stringthumbnail title

Defined in

packages/react-learn-card/src/components/MiniVCThumbnail/types.ts:1


NotificationProps

Ƭ NotificationProps: Object

Type declaration

NameType
className?string
issueDatestring
issuerImage?string
notificationTypeNotificationTypeEnum
onClick() => void
titlestring

Defined in

packages/react-learn-card/src/components/Notification/types.ts:10


QRCodeCardProps

Ƭ QRCodeCardProps: Object

Type declaration

NameTypeDescription
className?stringcustom className
qrCodeValuestringqr code value
text?stringtext to display on the card
userHandle?stringuser handle

Defined in

packages/react-learn-card/src/components/QRCodeCard/types.ts:1


RoundedSquareProps

Ƭ RoundedSquareProps: Object

Type declaration

NameType
bgColor?string
count?string | number
description?string
iconSrc?string
imgSrc?string
onClick?() => void
title?string
type?string

Defined in

packages/react-learn-card/src/components/RoundedSquare/RoundedSquare.tsx:9


SchoolIDCardProps

Ƭ SchoolIDCardProps: Object

Type declaration

NameTypeDescription
backgroundImagestringfixed ID background
className?stringcustom className
containerClassName?stringcustom container className
extraText?stringextra text to display on the ID card
text?React.ReactNode | stringtext to display below the student name
userImagestringstudent image
userNamestringstudent name

Defined in

packages/react-learn-card/src/components/SchoolIdCard/types.ts:1


VCCardProps

Ƭ VCCardProps: Object

Type declaration

NameType
className?string
credentialVC
issueeOverride?Profile

Defined in

packages/react-learn-card/src/components/VCCard/VCCard.tsx:7


VCDisplayCardPropsReal

Ƭ VCDisplayCardPropsReal: Object

Type declaration

NameType
className?string
credentialVC | AchievementCredential
issueeOverride?Profile
loading?boolean
subjectImageComponent?React.ReactNode
verification?VerificationItem[]

Defined in

packages/react-learn-card/src/components/VCDisplayCard/VCDisplayCard.tsx:10


VCThumbnailProps

Ƭ VCThumbnailProps: Object

Type declaration

NameTypeDescription
badgeImage?stringbadge image
className?stringcustom className
createdAt?stringissue date
issuerImage?stringissuer image
listView?booleancondensed or full view of the thumbnail Param shows full view by default.
onClick?() => void
title?stringthumbnail title
userImage?stringuser image
userImageComponent?React.ReactNode-

Defined in

packages/react-learn-card/src/components/VCThumbnail/types.ts:3


VCVerificationCheckProps

Ƭ VCVerificationCheckProps: Object

Type declaration

NameType
loading?boolean
size?string | number

Defined in

packages/react-learn-card/src/components/VCVerificationCheck/VCVerificationCheck.tsx:5

Variables

NotificationTypeStyles

Const NotificationTypeStyles: Object

Type declaration

NameType
achievement{ IconComponent: FC<{ className?: string ; color?: string }> = Trophy; claimedButtonStyles: string = 'text-spice-400 bg-spice-50 border-spice-50'; iconCircleStyles: string = 'bg-spice-400'; textStyles: string = 'text-spice-400 capitalize'; unclaimedButtonStyles: string = 'text-white bg-spice-400 border-spice-400'; viewButtonStyles: string = 'border-spice-400 text-spice-400' }
achievement.IconComponentFC<{ className?: string ; color?: string }>
achievement.claimedButtonStylesstring
achievement.iconCircleStylesstring
achievement.textStylesstring
achievement.unclaimedButtonStylesstring
achievement.viewButtonStylesstring
currency{ IconComponent: FC<{ className?: string }> = Coins; claimedButtonStyles: string = 'text-cyan-600 bg-cyan-50 border-cyan-50'; iconCircleStyles: string = 'bg-cyan-600'; textStyles: string = 'text-cyan-600 capitalize'; unclaimedButtonStyles: string = 'text-white bg-cyan-600 border-cyan-600'; viewButtonStyles: string = 'border-cyan-600 text-cyan-600' }
currency.IconComponentFC<{ className?: string }>
currency.claimedButtonStylesstring
currency.iconCircleStylesstring
currency.textStylesstring
currency.unclaimedButtonStylesstring
currency.viewButtonStylesstring
id{ IconComponent: FC<{ className?: string }> = User; claimedButtonStyles: string = 'text-yellow-400 bg-yellow-50 border-yellow-50'; iconCircleStyles: string = 'bg-yellow-400'; textStyles: string = 'text-yellow-400 uppercase'; unclaimedButtonStyles: string = 'text-white bg-yellow-400 border-yellow-400'; viewButtonStyles: string = 'border-yellow-400 text-yellow-400' }
id.IconComponentFC<{ className?: string }>
id.claimedButtonStylesstring
id.iconCircleStylesstring
id.textStylesstring
id.unclaimedButtonStylesstring
id.viewButtonStylesstring
job{ IconComponent: FC<{ className?: string }> = Briefcase; claimedButtonStyles: string = 'text-emerald-400 bg-emerald-50 border-emerald-50'; iconCircleStyles: string = 'bg-emerald-400'; textStyles: string = 'text-emerald-400 capitalize'; unclaimedButtonStyles: string = 'text-white bg-emerald-400 border-emerald-400'; viewButtonStyles: string = 'border-emerald-400 text-emerald-400' }
job.IconComponentFC<{ className?: string }>
job.claimedButtonStylesstring
job.iconCircleStylesstring
job.textStylesstring
job.unclaimedButtonStylesstring
job.viewButtonStylesstring
learning{ IconComponent: FC<{ className?: string }> = Graduation; claimedButtonStyles: string = 'text-rose-400 bg-rose-50 border-rose-50'; iconCircleStyles: string = 'bg-rose-400'; textStyles: string = 'text-rose-400 capitalize'; unclaimedButtonStyles: string = 'text-white bg-rose-400 border-rose-400'; viewButtonStyles: string = 'border-rose-400 text-rose-400' }
learning.IconComponentFC<{ className?: string }>
learning.claimedButtonStylesstring
learning.iconCircleStylesstring
learning.textStylesstring
learning.unclaimedButtonStylesstring
learning.viewButtonStylesstring
skill{ IconComponent: FC<{ className?: string }> = Lightbulb; claimedButtonStyles: string = 'text-indigo-400 bg-indigo-50 border-indigo-50'; iconCircleStyles: string = 'bg-indigo-400'; textStyles: string = 'text-indigo-400 capitalize'; unclaimedButtonStyles: string = 'text-white bg-indigo-400 border-indigo-400'; viewButtonStyles: string = 'border-indigo-400 text-indigo-400' }
skill.IconComponentFC<{ className?: string }>
skill.claimedButtonStylesstring
skill.iconCircleStylesstring
skill.textStylesstring
skill.unclaimedButtonStylesstring
skill.viewButtonStylesstring

Defined in

packages/react-learn-card/src/components/Notification/types.ts:19


TYPE_TO_IMG_SRC

Const TYPE_TO_IMG_SRC: Object

Defined in

packages/react-learn-card/src/components/RoundedSquare/constants.ts:28


TYPE_TO_MINI_ICON

Const TYPE_TO_MINI_ICON: any

Defined in

packages/react-learn-card/src/components/RoundedSquare/constants.ts:13


TYPE_TO_WALLET_COLOR

Const TYPE_TO_WALLET_COLOR: Object

Defined in

packages/react-learn-card/src/components/RoundedSquare/constants.ts:37


WALLET_SUBTYPES

Const WALLET_SUBTYPES: Object

Type declaration

NameType
ACHIEVEMENTSstring
CURRENCIESstring
IDSstring
JOB_HISTORYstring
LEARNING_HISTORYstring
SKILLSstring

Defined in

packages/react-learn-card/src/components/RoundedSquare/constants.ts:19

Functions

AchievementCard

AchievementCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<AchievementCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


Briefcase

Briefcase(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<{ className?: string }>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


Button

Button(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<ButtonProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


Checkmark

Checkmark(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<{ className?: string }>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


CheckmarkSvg

CheckmarkSvg(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<InlineSVGProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


CircleCheckButton

CircleCheckButton(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<CircleCheckButtonProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


CircleIcon

CircleIcon(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<CircleIconProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


Coins

Coins(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<{ className?: string }>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


CountCircle

CountCircle(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<CountCircleProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


CourseCard

CourseCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<CourseCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


CourseVerticalCard

CourseVerticalCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<CourseCardVerticalProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


FlippyCard

FlippyCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<FlippyCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


Graduation

Graduation(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<{ className?: string }>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


JobListCard

JobListCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<JobListCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


JobListingBubble

JobListingBubble(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<JobListingBubbleProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


LearnCardCreditCardBackFace

LearnCardCreditCardBackFace(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<LearnCardCreditCardBackFaceProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


LearnCardCreditCardFrontFace

LearnCardCreditCardFrontFace(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<LearnCardCreditCardFrontFaceProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


LearnPill

LearnPill(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<LearnPillProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


Lightbulb

Lightbulb(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<{ className?: string }>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


MiniVCThumbnail

MiniVCThumbnail(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<MiniVCThumbnailProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


Notification

Notification(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<NotificationProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


QRCodeCard

QRCodeCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<QRCodeCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


RoundedPill

RoundedPill(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<RoundedPillProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


RoundedSquare

RoundedSquare(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<RoundedSquareProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


SchoolIDCard

SchoolIDCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<SchoolIDCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


SkillTabCard

SkillTabCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<SkillTabCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


SkillVerticalCard

SkillVerticalCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<SkillVerticalCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


SkillsCard

SkillsCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<SkillsCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


SkillsMeterSegment

SkillsMeterSegment(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<SkillsMeterSegmentProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


SkillsStatsCard

SkillsStatsCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<SkillsStatsCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


SmallAchievementCard

SmallAchievementCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<SmallAchievementCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


Trophy

Trophy(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<{ className?: string ; color?: string }>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


User

User(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<{ className?: string }>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


VCCard

VCCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<VCCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


VCDisplayBackFace

VCDisplayBackFace(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<VCDisplayCardProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


VCDisplayCard

VCDisplayCard(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<VCDisplayCardPropsReal>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


VCThumbnail

VCThumbnail(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<VCThumbnailProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


VCVerificationCheck

VCVerificationCheck(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<VCVerificationCheckProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


VCVerificationCheckWithText

VCVerificationCheckWithText(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<VCVerificationCheckProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543


ValidationStateIndicator

ValidationStateIndicator(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<VerifiableStateIndicatorProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/.pnpm/@types+react@17.0.47/node_modules/@types/react/index.d.ts:543