Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@codersrank/work-experience

Package Overview
Dependencies
Maintainers
5
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@codersrank/work-experience

Codersrank Work Experience Widget

  • 0.9.7
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
209
decreased by-2.79%
Maintainers
5
Weekly downloads
 
Created
Source

Codersrank Work Experience Widget

Codersrank Work Experience Widget is a web component that allows you easily integrate work experience information from your CodersRank profile to your personal website:

Install from NPM

Widget script available through NPM:

npm i @codersrank/work-experience --save

After installation you need to import and register web component:

import CodersrankWorkExperience from '@codersrank/work-experience';

// register web component as <codersrank-work-experience> element
window.customElements.define('codersrank-work-experience', CodersrankWorkExperience);

Install from CDN

Widget can also be downloaded or linked directly from CDN:

<!-- replace x.x.x with actual version -->
<script src="https://unpkg.com/@codersrank/work-experience@x.x.x/codersrank-work-experience.min.js"></script>

In this case it is not required to register web component, it is already registered as <codersrank-work-experience> element.

Usage

As it is a web component the usage is pretty simple, just add widget HTML tag with your CodersRank username

<codersrank-work-experience username="YOUR_USERNAME"></codersrank-work-experience>

Widget Attributes

Widget supports following properties as HTML element attributes:

NameTypeDefaultDescription
usernamestringYour CodersRank username
logosbooleanfalseEnables company logos
max-itemsnumberLimit number of work experiences to display
gridbooleanfalseEnables grid layout. Number of columns is configurable with --grid-columns CSS variable
brandingbooleantrueDisplays "Powered by CodersRank" link

For example:

<codersrank-work-experience username="YOUR_USERNAME" logos></codersrank-work-experience>

Styling

It is possible to customize widget colors with CSS Custom Properties (CSS Variables) by setting them directly on the widget element with style attribute or in CSS.

There are following CSS Custom Properties are available:

PropertyValue
--preloader-color#72a0a8
--item-spacing2em
--item-border-radius0px
--item-bordernone
--item-padding0px
--item-bg-color0px
--grid-columns1
--logo-size48px
--logo-margin16px
--nested-circle-size12px
--nested-circle-border-width2px
--nested-circle-opacity0.25
--nested-line-opacity0.25
--nested-line-width2px
--company-font-size1.15em
--company-font-weightbold
--company-text-colorinherit
--company-opacity1
--title-font-sizeinherit
--title-font-weightbold
--title-text-colorinherit
--title-opacity1
--location-text-colorinherit
--location-opacity0.55
--location-font-sizeinherit
--location-font-weightinherit
--date-text-colorinherit
--date-opacity0.55
--date-font-sizeinherit
--date-font-weightinherit
--description-font-sizeinherit
--description-font-weightinherit
--description-text-colorinherit
--description-opacity1
--tag-bordernone
--tag-star-color#ff9900
--tag-bg-colorrgba(0, 0, 100, 0.075)
--tag-font-size0.85em
--tag-font-weightbold
--tag-padding0.35em 0.57em
--tag-margin0.28em
--tag-border-radius4px
--tag-text-colorinherit
--branding-text-colorinherit

For example, to change work experience title color to purple and font-size to 20px, add this to CSS stylesheet:

codersrank-work-experience {
  --title-text-color: purple;
  --title-font-size: 20px;
}

Use As Image

It is also possible to insert Work Experience widget as an image. It is useful in places where you can't integrate web component, or for example on your GitHub profile README.md page.

Image URL is the following:

https://cr-ss-service.azurewebsites.net/api/ScreenShot?widget=work-experience&username=YOUR_USERNAME

It accepts all widget attributes as query string parameters, plus one extra parameter:

NameTypeDefaultDescription
widthnumber800Width of widget element (generated image). Note that generated image has @2x pixel density, so the PNG image will be actually generated in @2x size from the one specified here
stylestringstyle attribute value (here you can specify all CSS variables)

For example:

<img
  src="https://cr-ss-service.azurewebsites.net/api/ScreenShot?widget=education&username=YOUR_USERNAME&max-items=2&logos=true&style=--item-bg-color:%23f00;--item-border-radius:10px"
/>

Note that you need to URL Encode some of the characters, for example # should be %23 and #ff0 color should be specified as %23ff0 in query.

Contribution

Yes please! See the contributing guidelines for details.

Licence

This project is licensed under the terms of the MIT license.

Keywords

FAQs

Package last updated on 21 Dec 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc