Skip to content

Commit

Permalink
Manage dependencies for visual tests and add shields to Readmes (#7188)
Browse files Browse the repository at this point in the history
  • Loading branch information
deleonio authored Dec 11, 2024
2 parents 29c3957 + 3fd4932 commit c0d89d3
Show file tree
Hide file tree
Showing 26 changed files with 215 additions and 39 deletions.
8 changes: 8 additions & 0 deletions packages/adapters/angular/v15/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Angular-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/angular-v15)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/angular-v15)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/angular-v15)](https://www.npmjs.com/package/@public-ui/angular-v15)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/angular-v15)](https://bundlephobia.com/result?p=@public-ui/angular-v15)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

Das [**Angular**](https://angular.io)-Modul ist der Framework-Adapter für die Komponenten-Bibliothek.

Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden.
Expand Down
8 changes: 8 additions & 0 deletions packages/adapters/angular/v16/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Angular-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/angular-v16)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/angular-v16)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/angular-v16)](https://www.npmjs.com/package/@public-ui/angular-v16)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/angular-v16)](https://bundlephobia.com/result?p=@public-ui/angular-v16)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

Das [**Angular**](https://angular.io)-Modul ist der Framework-Adapter für die Komponenten-Bibliothek.

Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden.
Expand Down
8 changes: 8 additions & 0 deletions packages/adapters/angular/v17/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Angular-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/angular-v17)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/angular-v17)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/angular-v17)](https://www.npmjs.com/package/@public-ui/angular-v17)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/angular-v17)](https://bundlephobia.com/result?p=@public-ui/angular-v17)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

Das [**Angular**](https://angular.io)-Modul ist der Framework-Adapter für die Komponenten-Bibliothek.

Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden.
Expand Down
8 changes: 8 additions & 0 deletions packages/adapters/angular/v18/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Angular-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/angular-v18)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/angular-v18)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/angular-v18)](https://www.npmjs.com/package/@public-ui/angular-v18)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/angular-v18)](https://bundlephobia.com/result?p=@public-ui/angular-v18)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

Das [**Angular**](https://angular.io)-Modul ist der Framework-Adapter für die Komponenten-Bibliothek.

Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden.
Expand Down
8 changes: 8 additions & 0 deletions packages/adapters/hydrate/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - Hydrate-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/hydrate)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/hydrate)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/hydrate)](https://www.npmjs.com/package/@public-ui/hydrate)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/hydrate)](https://bundlephobia.com/result?p=@public-ui/hydrate)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

## Motivation

Provide an adapter for Server Side Rendering of KoliBri components.
Expand Down
8 changes: 8 additions & 0 deletions packages/adapters/preact/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - Preact-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/react)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/react)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/react)](https://www.npmjs.com/package/@public-ui/react)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/react)](https://bundlephobia.com/result?p=@public-ui/themes)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

The [Preact](https://github.com/preactjs/preact) adapter is a wrapper around the React adapter. Please refer to the [React adapter documentation](../react/README.md) for more information.

⚠️ Preact support is currently considered experimental.
8 changes: 8 additions & 0 deletions packages/adapters/react-standalone/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - Standalone React-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/react-standalone)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/react-standalone)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/react-standalone)](https://www.npmjs.com/package/@public-ui/react-standalone)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/react-standalone)](https://bundlephobia.com/result?p=@public-ui/react-standalone)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

## Motivation

Provide an adapter for [React](https://reactjs.org) to use the KoliBri components, without the need for a build/bundle process.
Expand Down
8 changes: 8 additions & 0 deletions packages/adapters/react/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - React-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/react)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/react)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/react)](https://www.npmjs.com/package/@public-ui/react)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/react)](https://bundlephobia.com/result?p=@public-ui/react)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

## Motivation

Provide an adapter for [React](https://reactjs.org) to use the KoliBri components.
Expand Down
12 changes: 10 additions & 2 deletions packages/adapters/solid/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - Solid-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/solid)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/solid)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/solid)](https://www.npmjs.com/package/@public-ui/solid)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/solid)](https://bundlephobia.com/result?p=@public-ui/solid)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

## Motivation

Provide an adapter for [SolidJS](https://www.solidjs.com/) to use the KoliBri components.
Expand All @@ -16,12 +24,12 @@ yarn add -g @public-ui/solid

## Usage

First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/themes) and create a Solid root:
First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/solid) and create a Solid root:

```ts
import { defineCustomElements } from '@public-ui/components/dist/loader';
import { register } from '@public-ui/components';
import { DEFAULT } from '@public-ui/themes';
import { DEFAULT } from '@public-ui/solid';

register(DEFAULT, defineCustomElements)
.then(() => {
Expand Down
8 changes: 8 additions & 0 deletions packages/adapters/vaadin/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Vaadin-Adapter for KoliBri

[![npm](https://img.shields.io/npm/v/@public-ui/vaadin)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/vaadin)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/vaadin)](https://www.npmjs.com/package/@public-ui/vaadin)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/vaadin)](https://bundlephobia.com/result?p=@public-ui/vaadin)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

## Open points

| Feature | Status |
Expand Down
10 changes: 9 additions & 1 deletion packages/adapters/vue/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - Vue-Adapter

[![npm](https://img.shields.io/npm/v/@public-ui/vue)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/vue)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/vue)](https://www.npmjs.com/package/@public-ui/vue)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/vue)](https://bundlephobia.com/result?p=@public-ui/vue)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

## Motivation

Provide an adapter for [Vue](https://vuejs.org/) to use the KoliBri components.
Expand All @@ -16,7 +24,7 @@ yarn add -g @public-ui/vue

## Usage

First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/themes) and create a Vue app:
First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/vue) and create a Vue app:

```ts
import { createApp } from 'vue';
Expand Down
8 changes: 8 additions & 0 deletions packages/components/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Components (Library)

[![npm](https://img.shields.io/npm/v/@public-ui/components)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/components)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/components)](https://www.npmjs.com/package/@public-ui/components)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/components)](https://bundlephobia.com/result?p=@public-ui/components)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

Das **Components**-Modul beinhaltet **alle** zur Komponenten-Bibliothek gehörenden **Web Components**.

Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden.
Expand Down
8 changes: 8 additions & 0 deletions packages/designer/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - Designer

[![npm](https://img.shields.io/npm/v/@public-ui/designer)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/designer)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/designer)](https://www.npmjs.com/package/@public-ui/designer)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/designer)](https://bundlephobia.com/result?p=@public-ui/designer)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

## Motivation

The designer is a tool that helps with creating and adjusting [KoliBri themes](https://github.com/public-ui/kolibri/tree/develop/packages/themes).
Expand Down
8 changes: 8 additions & 0 deletions packages/samples/angular/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Angular

[![npm](https://img.shields.io/npm/v/@public-ui/sample-angular)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/sample-angular)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/sample-angular)](https://www.npmjs.com/package/@public-ui/sample-angular)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/sample-angular)](https://bundlephobia.com/result?p=@public-ui/sample-angular)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.0.

## Development server
Expand Down
8 changes: 8 additions & 0 deletions packages/samples/react/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - React Sample App

[![npm](https://img.shields.io/npm/v/@public-ui/sample-react)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/sample-react)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/sample-react)](https://www.npmjs.com/package/@public-ui/sample-react)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/sample-react)](https://bundlephobia.com/result?p=@public-ui/sample-react)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

## Motivation

Showcase of all KoliBri components in a React application.
Expand Down
8 changes: 8 additions & 0 deletions packages/themes/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - Themes

[![npm](https://img.shields.io/npm/v/@public-ui/themes)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/themes)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/themes)](https://www.npmjs.com/package/@public-ui/themes)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/themes)](https://bundlephobia.com/result?p=@public-ui/themes)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

The **Themes** module contains numerous themes (style guides) for the component library. They can be loaded in combination with the Components module.

You can read more about **modularization** in the [architecture concept](https://public-ui.github.io/docs/concepts/architecture).
Expand Down
8 changes: 8 additions & 0 deletions packages/themes/default/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Public UI - Default-Theme

[![npm](https://img.shields.io/npm/v/@public-ui/theme-default)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/theme-default)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/theme-default)](https://www.npmjs.com/package/@public-ui/theme-default)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/theme-default)](https://bundlephobia.com/result?p=@public-ui/theme-default)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

This is the default theme for the [Public UI web component library](https://public-ui.github.io). You can customize this theme by using `css variables` or by creating a new theme.

## Integration in React
Expand Down
1 change: 0 additions & 1 deletion packages/themes/default/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
},
"devDependencies": {
"@public-ui/components": "workspace:*",
"@public-ui/sample-react": "workspace:*",
"@public-ui/visual-tests": "workspace:*",
"@rollup/plugin-commonjs": "28.0.1",
"@rollup/plugin-node-resolve": "15.3.0",
Expand Down
8 changes: 8 additions & 0 deletions packages/themes/ecl/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# KoliBri - ECL-Themes

[![npm](https://img.shields.io/npm/v/@public-ui/theme-ecl)](https://www.npmjs.com/package/@public-ui/components)
[![license](https://img.shields.io/npm/l/@public-ui/theme-ecl)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
[![downloads](https://img.shields.io/npm/dt/@public-ui/theme-ecl)](https://www.npmjs.com/package/@public-ui/theme-ecl)
[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
[![size](https://img.shields.io/bundlephobia/min/@public-ui/theme-ecl)](https://bundlephobia.com/result?p=@public-ui/theme-ecl)
![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)

## Motivation

The ECL themes provide styling according to the Styleguides of the European Commission and European Union for KoliBri-Components.
Expand Down
1 change: 0 additions & 1 deletion packages/themes/ecl/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
},
"devDependencies": {
"@public-ui/components": "workspace:*",
"@public-ui/sample-react": "workspace:*",
"@public-ui/visual-tests": "workspace:*",
"@rollup/plugin-commonjs": "28.0.1",
"@rollup/plugin-node-resolve": "15.3.0",
Expand Down
Loading

0 comments on commit c0d89d3

Please sign in to comment.