Skip to content

[SDK] Fix: Add JSDoc documentation for getSocialIcon function #5395

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

Merged
merged 1 commit into from
Nov 12, 2024
Merged

[SDK] Fix: Add JSDoc documentation for getSocialIcon function #5395

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions packages/thirdweb/src/react/core/utils/walletIcon.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,17 @@ export const socialIcons = {
github: githubIconUri,
};

// TODO: this should return actual <svg> elements so they can be themed
export function getSocialIcon(provider: AuthOption | ({} & string)) {
/**
* Gets the icon URI for a given social authentication provider
* @param provider - The authentication provider to get the icon for
* @returns A data URI containing the SVG icon for the provider, or a generic wallet icon if the provider is not recognized
* @example
* ```tsx
* const googleIcon = getSocialIcon("google")
* const appleIcon = getSocialIcon("apple")
* ```
*/
export function getSocialIcon(provider: AuthOption | ({} & string)): string {
switch (provider) {
case "google":
return googleIconUri;
Expand Down
Loading