Piktor Profile
This repo is used to host the Piktor Profile component that we have developed, to use as a module in our products.
Installation
-
Install Piktor Profile using npm or yarn.
npm install piktor-profileyarn add piktor-profile -
Import it into your project
; -
Use it as follows
<PiktorProfileuserData={user}callback={key => callbackHandler(key)}customStyle={customStyle}editable/>
Props
-
UserData - Pass a user object in the structure mentioned below:
user_name: STRINGuser_id: STRINGuser_photo: STRINGuser_email: STRINGuser_mobile: STRINGdesignation: STRINGjob_location: STRINGuser_social_profiles:social_platform: STRINGactiveIcon: FILEinactiveIcon: FILEisEnabled: BOOLEANusername: STRINGlink: STRINGid: STRINGaspirations:skills:"_id" : STRING"name" : STRING"id" : STRING"icon" : FILE"achievement" : BOOLEANrecognitions:"_id" : STRING"title" : STRING"issuer" : STRING"issue_date" : STRING"description" : STRING"id" : STRINGwork_experience:"_id" : STRING"title" : STRING"company_name" : STRING"start_date" : DATE"end_date" : DATE || STRING"description" : STRING"place" : STRINGeducation:"_id" : STRING"school" : STRING"degree" : STRING"start_year" : STRING"end_year" : STRING"id" : STRINGpersonalStatement: STRING -
Editing - Boolean to specify if profile is in edit state or not.
-
Editable - The boolean to specify whether it is editable, or view only.
-
customStyle - The style prop. Right now, it supports these properties: primaryColor, secondaryColor, fontFamilyMain, fontFamilyTitle, fontFamilyHeading.
-
callback - A generic callback for all connections from the profile to the application. You will receive a key, and an optional list of arguements, which you can handle in your application.