Data

Tools

Indexes

Applications

Experiments

Open Source Science

@kit-data-manager/react-pid-component

The PID-Component is a web component that can be used to display PIDs, ORCiDs, and possibly other identifiers in a user-friendly way. It is easily extensible to support other identifier types.

https://github.com/kit-data-manager/pid-component

Science Score: 85.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    3 of 6 committers (50.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization kit-data-manager has institutional domain (www.scc.kit.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary

Keywords

fair-data fair-do handle pid stenciljs storybook tailwindcss typescript web-component

Keywords from Contributors

interactive restful-api mesh interpretability profiles sequences generic projection standardization optim
Last synced: 6 months ago · JSON representation ·

Repository

The PID-Component is a web component that can be used to display PIDs, ORCiDs, and possibly other identifiers in a user-friendly way. It is easily extensible to support other identifier types.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 2
  • Open Issues: 3
  • Releases: 25
Topics
fair-data fair-do handle pid stenciljs storybook tailwindcss typescript web-component
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Codemeta

README.md

PID Component

Build CodeQL DOI npm version npm downloads License Storybook

The pid-component is an easily extensible web component that can be used to display PIDs, ORCiDs, and other identifiers in a user-friendly way. It is easily extensible to support other identifier types.

A React wrapper is also available

The pid-component dynamically renders a component based on the value of the value property. Depending on the value, it decides which component to render, what priority to give it, and what props to pass to it. It also renders itself recursively for all its children when unfolded. You can set the maximum depth of recursion with the level-of-subcomponents property. By default, it is set to 1, which means that it will only render the first level of children, but not their children. You can prohibit unfolding of the component by setting the current-level-of-subcomponents to the same value as the level-of-subcomponents property.

To use the component, import the npm-package via unpkg:

html <head> <script type="module" src="https://unpkg.com/@kit-data-manager/pid-component"></script> </head>

Alternatively, you can install the package via npm:

bash npm install @kit-data-manager/pid-component

Then, you can use this component like this:

```html

```

You can try this web component in the demo.

Only use the pid-component component! All the others are just for prototyping...

There are detailed docs for the pid-component component available in the Storybook and in the source code.

Please notice that you must use the hyphenated version of an attribute when using the component directly in HTML ( e.g. currentLevelOfSubcomponents -> current-level-of-subcomponents). When using inside Stencil or with JSX/TSX syntax, you must use the camelCase version.

Monorepo

This is a monorepo containing the following packages:

  • stencil-library (@kit-data-manager/pid-component)
  • react-library (@kit-data-manager/react-pid-component)

Lerna is used for managing and building the packages (but you can also do it manually). To use, install Lerna:

npm install --global lerna

and then use it to build the packages:

lerna run build

It will make sure to build the packages in the correct order.

How to run when developing

  1. Clone the repo
  2. Run npm install

For running storybook in dev mode, navigate to packages/stencil-library and run these commands in separate terminals:

  • npm run buildWatch
  • npm run storybook

Attention: Do NOT run npm run start. It will cause the storybook to not work properly. If you did run npm run start, delete the following folders (in packages/stencil-library) and run npm install again:

  • node_modules
  • www
  • dist
  • loader
  • .stencil

Owner

  • Name: KIT Data Manager
  • Login: kit-data-manager
  • Kind: organization
  • Email: webmaster@datamanger.kit.edu
  • Location: Karlsruhe, Germany

Generic software and recommendations for FAIR research data management by DEM.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
type: software
title: pid-component
abstract: Monorepo for the PID Component and related packages
version: 0.2.2
authors:
  - orcid: https://orcid.org/0009-0005-2800-4833
    given-names: Maximilian
    affiliation: Karlsruhe Institute of Technology (KIT)
    family-names: Inckmann
    email: maximilian.inckmann@kit.edu
  - orcid: https://orcid.org/0009-0003-2196-9187
    given-names: Christopher
    affiliation: Karlsruhe Institute of Technology (KIT)
    family-names: Raquet
    email: christopher.raquet@kit.edu
  - orcid: https://orcid.org/0000-0001-6575-1022
    given-names: Andreas
    affiliation: Karlsruhe Institute of Technology (KIT)
    family-names: Pfeil
    email: andreas.pfeil@kit.edu
  - orcid: https://orcid.org/0000-0003-2804-688X
    given-names: Thomas
    affiliation: Karlsruhe Institute of Technology (KIT)
    family-names: Jejkal
    email: thomas.jejkal@kit.edu
contact:
  - orcid: https://orcid.org/0009-0005-2800-4833
    given-names: Maximilian
    affiliation: Karlsruhe Institute of Technology (KIT)
    family-names: Inckmann
    email: maximilian.inckmann@kit.edu
  - orcid: https://orcid.org/0009-0003-2196-9187
    given-names: Christopher
    affiliation: Karlsruhe Institute of Technology (KIT)
    family-names: Raquet
    email: christopher.raquet@kit.edu
license: Apache-2.0
keywords:
  - react
  - pid
  - datatyperegistry
  - handle.net
  - orcid
  - identifier
  - kit-data-manager
  - typescript
  - storybook
  - tailwindcss
  - fair
  - fairdata
  - fairdo
  - fairdigitalobject
url: https://kit-data-manager.github.io/pid-component
repository-code: https://github.com/kit-data-manager/pid-component

CodeMeta (codemeta.json) 

{
  "@context": [
    "https://doi.org/10.5063/schema/codemeta-2.0",
    "https://w3id.org/software-iodata",
    "https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/ontology.jsonld",
    "https://schema.org",
    "https://w3id.org/software-types"
  ],
  "@type": "SoftwareSourceCode",
  "author": [
    {
      "@type": "Person",
      "givenName": "Christopher",
      "familyName": "Raquet",
      "email": "christopher.raquet@kit.edu",
      "@id": "https://orcid.org/0009-0003-2196-9187",
      "identifier": "https://orcid.org/0009-0003-2196-9187",
      "affiliation": "Karlsruhe Institute of Technology (KIT)"
    },
    {
      "@type": "Person",
      "givenName": "Maximilian",
      "familyName": "Inckmann",
      "email": "maximilian.inckmann@kit.edu",
      "@id": "https://orcid.org/0009-0005-2800-4833",
      "identifier": "https://orcid.org/0009-0005-2800-4833",
      "affiliation": "Karlsruhe Institute of Technology (KIT)"
    },
    {
      "@type": "Person",
      "givenName": "Andreas",
      "familyName": "Pfeil",
      "email": "andreas.pfeil@kit.edu",
      "@id": "https://orcid.org/0000-0001-6575-1022",
      "identifier": "https://orcid.org/0000-0001-6575-1022",
      "affiliation": "Karlsruhe Institute of Technology (KIT)"
    },
    {
      "@type": "Person",
      "givenName": "Thomas",
      "familyName": "Jejkal",
      "email": "thomas.jejkal@kit.edu",
      "@id": "https://orcid.org/0000-0003-2804-688X",
      "identifier": "https://orcid.org/0000-0003-2804-688X",
      "affiliation": "Karlsruhe Institute of Technology (KIT)"
    }
  ],
  "name": "pid-component",
  "description": "Monorepo for the PID Component and related packages",
  "version": "0.2.2",
  "keywords": [
    "react",
    "pid",
    "datatyperegistry",
    "handle.net",
    "orcid",
    "identifier",
    "kit-data-manager",
    "typescript",
    "storybook",
    "tailwindcss",
    "fair",
    "fairdata",
    "fairdo",
    "fairdigitalobject"
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Christopher",
      "familyName": "Raquet",
      "email": "christopher.raquet@kit.edu",
      "@id": "https://orcid.org/0009-0003-2196-9187",
      "identifier": "https://orcid.org/0009-0003-2196-9187",
      "affiliation": "Karlsruhe Institute of Technology (KIT)"
    },
    {
      "@type": "Person",
      "givenName": "Maximilian",
      "familyName": "Inckmann",
      "email": "maximilian.inckmann@kit.edu",
      "@id": "https://orcid.org/0009-0005-2800-4833",
      "identifier": "https://orcid.org/0009-0005-2800-4833",
      "affiliation": "Karlsruhe Institute of Technology (KIT)"
    }
  ],
  "license": [
    "https://spdx.org/licenses/Apache-2.0"
  ],
  "softwareHelp": "https://kit-data-manager.github.io/pid-component",
  "codeRepository": "https://github.com/kit-data-manager/pid-component",
  "buildInstructions": "https://kit-data-manager.github.io/pid-component",
  "url": "https://kit-data-manager.github.io/pid-component"
}

GitHub Events

Total
  • Create event: 61
  • Release event: 9
  • Issues event: 3
  • Delete event: 56
  • Issue comment event: 61
  • Push event: 38
  • Pull request review comment event: 20
  • Pull request review event: 13
  • Pull request event: 114
  • Fork event: 1
Last Year
  • Create event: 61
  • Release event: 9
  • Issues event: 3
  • Delete event: 56
  • Issue comment event: 61
  • Push event: 38
  • Pull request review comment event: 20
  • Pull request review event: 13
  • Pull request event: 114
  • Fork event: 1

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 122
  • Total Committers: 6
  • Avg Commits per committer: 20.333
  • Development Distribution Score (DDS): 0.451
Past Year
  • Commits: 47
  • Committers: 5
  • Avg Commits per committer: 9.4
  • Development Distribution Score (DDS): 0.617
Top Committers
Name Email Commits
Maximilian Inckmann - KIT m****n@k****u 67
dependabot[bot] 4****] 28
Maximilian Inckmann k****t@i****e 10
Thomas Jejkal t****l@k****u 10
DragonFighter603 7****3 5
Andreas Pfeil a****l@k****u 2
Committer Domains (Top 20 + Academic)
kit.edu: 3 inckmann.de: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 14
  • Total pull requests: 250
  • Average time to close issues: 4 months
  • Average time to close pull requests: 23 days
  • Total issue authors: 6
  • Total pull request authors: 5
  • Average comments per issue: 0.43
  • Average comments per pull request: 0.88
  • Merged pull requests: 73
  • Bot issues: 1
  • Bot pull requests: 184
Past Year
  • Issues: 3
  • Pull requests: 124
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 1.01
  • Merged pull requests: 30
  • Bot issues: 1
  • Bot pull requests: 88
View more stats
Top Authors
Issue Authors
  • maximiliani (5)
  • ghost (5)
  • Pfeil (1)
  • ThomasJejkal (1)
  • pjoKIT (1)
Pull Request Authors
  • dependabot[bot] (338)
  • maximiliani (55)
  • craquet (12)
  • ghost (11)
  • ThomasJejkal (2)
  • DragonFighter603 (1)
Top Labels
Issue Labels
enhancement (7) good first issue (2) bug (1)
Pull Request Labels
dependencies (338) javascript (319) github_actions (19)

Packages

  • Total packages: 1
  • Total downloads:
    • npm 314 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 1
npmjs.org: @kit-data-manager/react-pid-component

React wrapper for the package @kit-data-manager/pid-component

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 314 Last month
Rankings
Dependent repos count: 25.0%
Average: 30.6%
Dependent packages count: 36.2%
Maintainers (1)
jejkal
Last synced: 6 months ago

Dependencies

.github/workflows/deploy-storybook.yml actions
  • actions/checkout v2.3.1 composite
  • bitovi/github-actions-storybook-to-github-pages v1.0.0 composite
.github/workflows/github-npm-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/real-npm-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
package-lock.json npm
  • 1231 dependencies
package.json npm
  • @storybook/addon-essentials ^7.1.1 development
  • @storybook/addon-interactions ^7.1.1 development
  • @storybook/addon-links ^7.1.1 development
  • @storybook/blocks ^7.1.1 development
  • @storybook/html ^7.1.1 development
  • @storybook/html-vite ^7.1.1 development
  • @storybook/testing-library ^0.2.0 development
  • @storybook/web-components-vite ^7.1.1 development
  • @types/jest ^27.5.2 development
  • @types/node ^16.18.11 development
  • gh-pages ^6.0.0 development
  • jest ^27.5.1 development
  • jest-cli ^27.4.5 development
  • puppeteer ^20.7.3 development
  • react ^18.2.0 development
  • react-dom ^18.2.0 development
  • stencil-tailwind-plugin ^1.8.0 development
  • storybook ^7.1.1 development
  • tailwindcss ^3.3.3 development
  • typescript ^5.1.6 development
  • @stencil/core ^4.0.0
  • @storybook/addon-styling ^1.3.4
  • autoprefixer ^10.4.14
  • color-hash ^2.0.2
  • postcss ^8.4.27