1.0.1 • Published 4 years ago

react-linkedin-profile-badge v1.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
4 years ago

react-linkedin-profile-badge

Easily add a LinkedIn profile badge widget to your React applications.

LinkedIn profile badge

Installation

Run npm i react-linkedin-profile-badge OR yarn add react-linkedin-profile-badge

Usage

Using this package is as simple as importing the LinkedInProfileBadge component from the library and passing props from the API. Only the profileId prop is required.

import React from 'react';
import LinkedInProfileBadge from 'react-linkedin-profile-badge';

const App: React.FC = () => {
	return <LinkedInProfileBadge profileId='ikemefunanwankwo' theme='dark' size='large' orientation='horizontal' />
}

export default App;

Props API

The following props can be passed to the LinkedInProfileBadge component, in addition to any HTML div element attributes.

PropRequiredDatatypePossible ValuesDefault ValueDescription
profileIdYesstringNoneYour LinkedIn profile ID, as identified by xxxx in the URL https://www.linkedin.com/in/xxxx/
themeNostringlight | darklightWidget theme color
sizeNostringmedium | largemediumWidget size
orientationNostringvertical | horizontalverticalWidget orientation type
versionNostringv1v1LinkedIn profile badge API version
localeNostringen_US | en_GBen_USLinkedIn profile badge API localization
showLinkNobooleantrue | falsefalseShow anchor link to LinkedIn profile below the badge
linkTextNostringnullLink text to show if showLink is enabled