Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ fabric.properties
# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
# Android studio 3.1+ serialized dataCache file
.idea/caches/build_file_checksums.ser

### WebStorm+all Patch ###
Expand Down
95 changes: 21 additions & 74 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,22 @@
[![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)](https://stenciljs.com)

# Stencil Component Starter

This is a starter project for building a standalone Web Component using Stencil.

Stencil is also great for building entire apps. For that, use the [stencil-app-starter](https://github.com/ionic-team/stencil-app-starter) instead.

# Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

## Getting Started

To start building a new web component using Stencil, clone this repo to a new directory:

```bash
git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin
```

and run:

```bash
npm install
npm start
```

To build the component for production, run:

```bash
npm run build
```

To run the unit tests for the components, run:

```bash
npm test
```

Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).


## Naming Components

When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: `<stencil-datepicker>`). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix `ion`.


## Using this component

There are three strategies we recommend for using web components built with Stencil.

The first step for all three of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages).

### Script tag

- Put a script tag similar to this `<script type='module' src='https://unpkg.com/my-component@0.0.1/dist/my-component.esm.js'></script>` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc

### Node Modules
- Run `npm install my-component --save`
- Put a script tag similar to this `<script type='module' src='node_modules/my-component/dist/my-component.esm.js'></script>` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc

### In a stencil-starter app
- Run `npm install my-component --save`
- Add an import to the npm packages `import my-component;`
- Then you can use the element anywhere in your template, JSX, html etc
## PID Component
This is a collection of web components to resolve and display all kinds of PID related information.
It is easily extendable and can be used in any web application.

TODO: Add more information

# How to run
1. Clone the repo
2. Run `npm install`

For running storybook in dev mode, run theses 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 and run `npm install` again:
- `node_modules`
- `www`
- `dist`
- `loader`
- `.stencil`
91 changes: 91 additions & 0 deletions src/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,47 @@ export namespace Components {
*/
"showOrcid": boolean;
}
interface DisplayMagic {
/**
* The amount of items to show in the table per page. Defaults to 10. (optional)
* @type {number}
*/
"amountOfItems": number;
/**
* Determines whether the colors of the table inside the component should change or not. Defaults to true. (optional)
* @type {boolean}
*/
"changingColors": boolean;
/**
* The current level of subcomponents. Defaults to 0. (optional)
* @type {number}
*/
"currentLevelOfSubcomponents": number;
/**
* The total amount of levels of subcomponents to show. Defaults to 1. (optional)
* @type {number}
*/
"levelOfSubcomponents": number;
/**
* Determines whether the component is open or not by default. Defaults to false. (optional)
* @type {boolean}
*/
"openStatus": boolean;
/**
* A stringified JSON object containing settings for this component. The resulting object is passed to every subcomponent, so that every component has the same settings. Values and the according type are defined by the components themselves. (optional) Schema: ```typescript { type: string, values: { name: string, value: any }[] }[] ```
* @type {string}
*/
"settings": string;
/**
* Determines whether subcomponents should generally be shown or not. If set to true but the total level of subcomponents is reached, subcomponents will not be shown. Defaults to true. (optional)
*/
"showSubcomponents": boolean;
/**
* The value to parse, evaluate and render.
* @type {string}
*/
"value": string;
}
interface FoldableComponent {
"actions": FoldableAction[];
/**
Expand Down Expand Up @@ -146,6 +187,12 @@ declare global {
prototype: HTMLBeautifulOrcidElement;
new (): HTMLBeautifulOrcidElement;
};
interface HTMLDisplayMagicElement extends Components.DisplayMagic, HTMLStencilElement {
}
var HTMLDisplayMagicElement: {
prototype: HTMLDisplayMagicElement;
new (): HTMLDisplayMagicElement;
};
interface HTMLFoldableComponentElement extends Components.FoldableComponent, HTMLStencilElement {
}
var HTMLFoldableComponentElement: {
Expand Down Expand Up @@ -176,6 +223,7 @@ declare global {
};
interface HTMLElementTagNameMap {
"beautiful-orcid": HTMLBeautifulOrcidElement;
"display-magic": HTMLDisplayMagicElement;
"foldable-component": HTMLFoldableComponentElement;
"handle-highlight": HTMLHandleHighlightElement;
"intelligent-handle": HTMLIntelligentHandleElement;
Expand Down Expand Up @@ -210,6 +258,47 @@ declare namespace LocalJSX {
*/
"showOrcid"?: boolean;
}
interface DisplayMagic {
/**
* The amount of items to show in the table per page. Defaults to 10. (optional)
* @type {number}
*/
"amountOfItems"?: number;
/**
* Determines whether the colors of the table inside the component should change or not. Defaults to true. (optional)
* @type {boolean}
*/
"changingColors"?: boolean;
/**
* The current level of subcomponents. Defaults to 0. (optional)
* @type {number}
*/
"currentLevelOfSubcomponents"?: number;
/**
* The total amount of levels of subcomponents to show. Defaults to 1. (optional)
* @type {number}
*/
"levelOfSubcomponents"?: number;
/**
* Determines whether the component is open or not by default. Defaults to false. (optional)
* @type {boolean}
*/
"openStatus"?: boolean;
/**
* A stringified JSON object containing settings for this component. The resulting object is passed to every subcomponent, so that every component has the same settings. Values and the according type are defined by the components themselves. (optional) Schema: ```typescript { type: string, values: { name: string, value: any }[] }[] ```
* @type {string}
*/
"settings"?: string;
/**
* Determines whether subcomponents should generally be shown or not. If set to true but the total level of subcomponents is reached, subcomponents will not be shown. Defaults to true. (optional)
*/
"showSubcomponents"?: boolean;
/**
* The value to parse, evaluate and render.
* @type {string}
*/
"value"?: string;
}
interface FoldableComponent {
"actions"?: FoldableAction[];
/**
Expand Down Expand Up @@ -315,6 +404,7 @@ declare namespace LocalJSX {
}
interface IntrinsicElements {
"beautiful-orcid": BeautifulOrcid;
"display-magic": DisplayMagic;
"foldable-component": FoldableComponent;
"handle-highlight": HandleHighlight;
"intelligent-handle": IntelligentHandle;
Expand All @@ -326,6 +416,7 @@ declare module "@stencil/core" {
export namespace JSX {
interface IntrinsicElements {
"beautiful-orcid": LocalJSX.BeautifulOrcid & JSXBase.HTMLAttributes<HTMLBeautifulOrcidElement>;
"display-magic": LocalJSX.DisplayMagic & JSXBase.HTMLAttributes<HTMLDisplayMagicElement>;
"foldable-component": LocalJSX.FoldableComponent & JSXBase.HTMLAttributes<HTMLFoldableComponentElement>;
/**
* This component highlights a handle and links to the FAIR DO Scope.
Expand Down
6 changes: 3 additions & 3 deletions src/components/beautiful-orcid/beautiful-orcid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,13 @@ export class BeautifulOrcid {
?
<span class="flex-nowrap font-mono text-sm px-1.5 font-medium hover:text-blue-400 divide-x">
{this.orcidInfo.familyName}, {this.orcidInfo.givenNames}
{this.orcidInfo.getAffiliationAt(this.affiliationAt) !== undefined && this.showAffiliation
? ` (${this.orcidInfo.getAffiliationAtString(this.affiliationAt, this.showDepartment)}${this.showOrcid ? ", " : ""}`
{this.orcidInfo.getAffiliationsAt(this.affiliationAt) !== undefined && this.showAffiliation
? ` (${this.orcidInfo.getAffiliationAsString(this.orcidInfo.getAffiliationsAt(this.affiliationAt)[0], this.showDepartment)}${this.showOrcid ? ", " : ""}`
: this.showOrcid ? " (" : ""}
{this.showOrcid
? <span class={"hover:text-[#A6CE39]"}>{this.orcidInfo.orcid}</span>
: ""}
{(this.orcidInfo.getAffiliationAt(this.affiliationAt) !== undefined && this.showAffiliation) || this.showOrcid ? ")" : ""}
{(this.orcidInfo.getAffiliationAsString(this.orcidInfo.getAffiliationsAt(this.affiliationAt)[0]) !== undefined && this.showAffiliation) || this.showOrcid ? ")" : ""}
</span>
: ""
}
Expand Down
3 changes: 3 additions & 0 deletions src/components/display-magic/display-magic.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
details summary::-webkit-details-marker {
display:none;
}
Loading