Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codersrank-org/timeline-widget
Integrate work experience, portfolio or skills from your CodersRank profile in a form of a timeline to your personal website
https://github.com/codersrank-org/timeline-widget
chart codersrank codersrank-widget portfolio profile skills webcomponent
Last synced: 4 months ago
JSON representation
Integrate work experience, portfolio or skills from your CodersRank profile in a form of a timeline to your personal website
- Host: GitHub
- URL: https://github.com/codersrank-org/timeline-widget
- Owner: codersrank-org
- License: mit
- Created: 2021-03-12T09:28:24.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-21T08:17:36.000Z (over 3 years ago)
- Last Synced: 2024-09-14T10:36:57.148Z (5 months ago)
- Topics: chart, codersrank, codersrank-widget, portfolio, profile, skills, webcomponent
- Language: JavaScript
- Homepage: https://codersrank.io
- Size: 399 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Codersrank Timeline Widget
Codersrank Timeline Widget is a web component that allows you easily integrate your work experience or portfolio information in a form of a timeline from your [CodersRank](https://codersrank.io) profile to your personal website:
## Install from NPM
Widget script available through NPM:
```
npm i @codersrank/timeline --save
```
After installation you need to import and register web component:
```js
import CodersrankTimeline from '@codersrank/timeline';
// register web component as element
window.customElements.define('codersrank-timeline', CodersrankTimeline);
```
## Install from CDN
Widget can also be downloaded or linked directly from CDN:
```html
```
In this case it is not required to register web component, it is already registered as `` element.
## Usage
As it is a web component the usage is pretty simple, just add widget HTML tag with your [CodersRank](https://codersrank.io) username
```html
```
## Widget Attributes
Widget supports following properties as HTML element attributes:
| Name | Type | Default | Description |
| ---------- | --------- | ---------------- | ---------------------------------------------------------------------------------- |
| `username` | `string` | | Your [CodersRank](https://codersrank.io) username |
| `type` | `string` | `workexperience` | Specify which data to show. Can be `workexperience`, `portfolio` or `technologies` |
| `branding` | `boolean` | `true` | Displays "Powered by CodersRank" link |
For example:
```html
```
## 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:
| Property | Value |
| ----------------------------- | -------------------------------- |
| --preloader-color | #72a0a8 |
| --year-font-size | 12px |
| --year-opacity | 0.5 |
| --year-height | 24px |
| --year-text-color | currentColor |
| --year-line-color | currentColor |
| --year-line-opacity | 0.25 |
| --col-width | 24px |
| --row-height | 36px |
| --timeline-item-bg-color | #f1f1f1 |
| --timeline-item-text-color | inherit |
| --timeline-item-font-size | 12px |
| --timeline-item-padding | 4px 8px |
| --timeline-item-border-radius | 4px |
| --tooltip-logo-size | 32px |
| --tooltip-font-size | 14px |
| --tooltip-width | 320px |
| --tooltip-padding | 16px |
| --tooltip-bg-color | #fff |
| --tooltip-border-radius | 4px |
| --tooltip-text-color | #333 |
| --tooltip-box-shadow | 0px 10px 20px rgba(0, 0, 0, 0.1) |
| --tag-border | none |
| --tag-star-color | #ff9900 |
| --tag-bg-color | rgba(0, 0, 100, 0.075) |
| --tag-font-size | 0.85em |
| --tag-font-weight | bold |
| --tag-padding | 0.35em 0.57em |
| --tag-margin | 0.28em |
| --tag-border-radius | 4px |
| --tag-text-color | inherit |
| --branding-text-color | inherit |
For example, to change year label font-size `14px`, add this to CSS stylesheet:
```css
codersrank-timeline {
--year-font-size: 14px;
}
```
## Contribution
Yes please! See the [contributing guidelines](https://github.com/codersrank-org/timeline-widget/blob/master/CONTRIBUTING.md) for details.
## Licence
This project is licensed under the terms of the [MIT license](https://github.com/codersrank-org/timeline-widget/blob/master/LICENSE).