@public-ui/solid 2.0.0-rc.8 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +40 -4
  2. package/dist/index.cjs +0 -2
  3. package/dist/index.d.ts +1 -2
  4. package/dist/index.mjs +1 -2
  5. package/package.json +8 -8
package/README.md CHANGED
@@ -1,7 +1,43 @@
1
- # Solid-Adapter
1
+ # KoliBri - Solid-Adapter
2
2
 
3
- Das [**Solid**](https://solidjs.com)-Modul ist der Framework-Adapter für die Komponenten-Bibliothek.
3
+ ## Motivation
4
4
 
5
- Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden.
5
+ Provide an adapter for [SolidJS](https://www.solidjs.com/) to use the KoliBri components.
6
6
 
7
- Mehr zum **Projekt** kann in der [README](https://public-ui.github.io/docs) nachgelesen werden.
7
+ ## Installation
8
+
9
+ You can install the adapter with `npm`, `pnpm` or `yarn`:
10
+
11
+ ```bash
12
+ npm i -g @public-ui/solid
13
+ pnpm i -g @public-ui/solid
14
+ yarn add -g @public-ui/solid
15
+ ```
16
+
17
+ ## Usage
18
+
19
+ First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/themes) and create a Solid root:
20
+
21
+ ```ts
22
+ import { defineCustomElements } from '@public-ui/components/dist/loader';
23
+ import { register } from '@public-ui/components';
24
+ import { DEFAULT } from '@public-ui/themes';
25
+
26
+ register(DEFAULT, defineCustomElements)
27
+ .then(() => {
28
+ const htmlDivElement: HTMLDivElement | null = document.querySelector('div#app');
29
+ if (htmlDivElement instanceof HTMLDivElement) {
30
+ render(() => <AppComponent />, htmlDivElement);
31
+ }
32
+ })
33
+ .catch(console.warn);
34
+ ```
35
+
36
+ Then, you can import any component from `@public-ui/solid` and render it within components:
37
+
38
+ ```tsx
39
+ import { Component } from 'solid-js';
40
+ import { KolButton } from '@public-ui/solid';
41
+
42
+ export const AppComponent: Component = () => <KolButton _label="Hello World" />;
43
+ ```
package/dist/index.cjs CHANGED
@@ -98,7 +98,6 @@ const KolLogo = /* @__PURE__ */ createSolidComponent("kol-logo");
98
98
  const KolModal = /* @__PURE__ */ createSolidComponent("kol-modal");
99
99
  const KolNav = /* @__PURE__ */ createSolidComponent("kol-nav");
100
100
  const KolPagination = /* @__PURE__ */ createSolidComponent("kol-pagination");
101
- const KolPopover = /* @__PURE__ */ createSolidComponent("kol-popover");
102
101
  const KolProgress = /* @__PURE__ */ createSolidComponent("kol-progress");
103
102
  const KolQuote = /* @__PURE__ */ createSolidComponent("kol-quote");
104
103
  const KolSelect = /* @__PURE__ */ createSolidComponent("kol-select");
@@ -147,7 +146,6 @@ exports.KolLogo = KolLogo;
147
146
  exports.KolModal = KolModal;
148
147
  exports.KolNav = KolNav;
149
148
  exports.KolPagination = KolPagination;
150
- exports.KolPopover = KolPopover;
151
149
  exports.KolProgress = KolProgress;
152
150
  exports.KolQuote = KolQuote;
153
151
  exports.KolSelect = KolSelect;
package/dist/index.d.ts CHANGED
@@ -35,7 +35,6 @@ declare const KolLogo: (props: solid_js.PropsWithChildren<JSX.KolLogo & solid_js
35
35
  declare const KolModal: (props: solid_js.PropsWithChildren<JSX.KolModal & solid_js.JSX.HTMLAttributes<HTMLKolModalElement>>) => HTMLKolModalElement;
36
36
  declare const KolNav: (props: solid_js.PropsWithChildren<JSX.KolNav & solid_js.JSX.HTMLAttributes<HTMLKolNavElement>>) => HTMLKolNavElement;
37
37
  declare const KolPagination: (props: solid_js.PropsWithChildren<JSX.KolPagination & solid_js.JSX.HTMLAttributes<HTMLKolPaginationElement>>) => HTMLKolPaginationElement;
38
- declare const KolPopover: (props: solid_js.PropsWithChildren<JSX.KolPopover & solid_js.JSX.HTMLAttributes<HTMLKolPopoverElement>>) => HTMLKolPopoverElement;
39
38
  declare const KolProgress: (props: solid_js.PropsWithChildren<JSX.KolProgress & solid_js.JSX.HTMLAttributes<HTMLKolProgressElement>>) => HTMLKolProgressElement;
40
39
  declare const KolQuote: (props: solid_js.PropsWithChildren<JSX.KolQuote & solid_js.JSX.HTMLAttributes<HTMLKolQuoteElement>>) => HTMLKolQuoteElement;
41
40
  declare const KolSelect: (props: solid_js.PropsWithChildren<JSX.KolSelect & solid_js.JSX.HTMLAttributes<HTMLKolSelectElement>>) => HTMLKolSelectElement;
@@ -50,4 +49,4 @@ declare const KolTextarea: (props: solid_js.PropsWithChildren<JSX.KolTextarea &
50
49
  declare const KolToastContainer: (props: solid_js.PropsWithChildren<JSX.KolToastContainer & solid_js.JSX.HTMLAttributes<HTMLKolToastContainerElement>>) => HTMLKolToastContainerElement;
51
50
  declare const KolVersion: (props: solid_js.PropsWithChildren<JSX.KolVersion & solid_js.JSX.HTMLAttributes<HTMLKolVersionElement>>) => HTMLKolVersionElement;
52
51
 
53
- export { KolAbbr, KolAccordion, KolAlert, KolAvatar, KolBadge, KolBreadcrumb, KolButton, KolButtonGroup, KolButtonLink, KolCard, KolDetails, KolForm, KolHeading, KolIcon, KolImage, KolIndentedText, KolInputCheckbox, KolInputColor, KolInputDate, KolInputEmail, KolInputFile, KolInputNumber, KolInputPassword, KolInputRadio, KolInputRange, KolInputText, KolKolibri, KolLink, KolLinkButton, KolLinkGroup, KolLogo, KolModal, KolNav, KolPagination, KolPopover, KolProgress, KolQuote, KolSelect, KolSkipNav, KolSpan, KolSpin, KolSplitButton, KolSymbol, KolTable, KolTabs, KolTextarea, KolToastContainer, KolVersion };
52
+ export { KolAbbr, KolAccordion, KolAlert, KolAvatar, KolBadge, KolBreadcrumb, KolButton, KolButtonGroup, KolButtonLink, KolCard, KolDetails, KolForm, KolHeading, KolIcon, KolImage, KolIndentedText, KolInputCheckbox, KolInputColor, KolInputDate, KolInputEmail, KolInputFile, KolInputNumber, KolInputPassword, KolInputRadio, KolInputRange, KolInputText, KolKolibri, KolLink, KolLinkButton, KolLinkGroup, KolLogo, KolModal, KolNav, KolPagination, KolProgress, KolQuote, KolSelect, KolSkipNav, KolSpan, KolSpin, KolSplitButton, KolSymbol, KolTable, KolTabs, KolTextarea, KolToastContainer, KolVersion };
package/dist/index.mjs CHANGED
@@ -96,7 +96,6 @@ const KolLogo = /* @__PURE__ */ createSolidComponent("kol-logo");
96
96
  const KolModal = /* @__PURE__ */ createSolidComponent("kol-modal");
97
97
  const KolNav = /* @__PURE__ */ createSolidComponent("kol-nav");
98
98
  const KolPagination = /* @__PURE__ */ createSolidComponent("kol-pagination");
99
- const KolPopover = /* @__PURE__ */ createSolidComponent("kol-popover");
100
99
  const KolProgress = /* @__PURE__ */ createSolidComponent("kol-progress");
101
100
  const KolQuote = /* @__PURE__ */ createSolidComponent("kol-quote");
102
101
  const KolSelect = /* @__PURE__ */ createSolidComponent("kol-select");
@@ -111,4 +110,4 @@ const KolTextarea = /* @__PURE__ */ createSolidComponent("kol-textarea");
111
110
  const KolToastContainer = /* @__PURE__ */ createSolidComponent("kol-toast-container");
112
111
  const KolVersion = /* @__PURE__ */ createSolidComponent("kol-version");
113
112
 
114
- export { KolAbbr, KolAccordion, KolAlert, KolAvatar, KolBadge, KolBreadcrumb, KolButton, KolButtonGroup, KolButtonLink, KolCard, KolDetails, KolForm, KolHeading, KolIcon, KolImage, KolIndentedText, KolInputCheckbox, KolInputColor, KolInputDate, KolInputEmail, KolInputFile, KolInputNumber, KolInputPassword, KolInputRadio, KolInputRange, KolInputText, KolKolibri, KolLink, KolLinkButton, KolLinkGroup, KolLogo, KolModal, KolNav, KolPagination, KolPopover, KolProgress, KolQuote, KolSelect, KolSkipNav, KolSpan, KolSpin, KolSplitButton, KolSymbol, KolTable, KolTabs, KolTextarea, KolToastContainer, KolVersion };
113
+ export { KolAbbr, KolAccordion, KolAlert, KolAvatar, KolBadge, KolBreadcrumb, KolButton, KolButtonGroup, KolButtonLink, KolCard, KolDetails, KolForm, KolHeading, KolIcon, KolImage, KolIndentedText, KolInputCheckbox, KolInputColor, KolInputDate, KolInputEmail, KolInputFile, KolInputNumber, KolInputPassword, KolInputRadio, KolInputRange, KolInputText, KolKolibri, KolLink, KolLinkButton, KolLinkGroup, KolLogo, KolModal, KolNav, KolPagination, KolProgress, KolQuote, KolSelect, KolSkipNav, KolSpan, KolSpin, KolSplitButton, KolSymbol, KolTable, KolTabs, KolTextarea, KolToastContainer, KolVersion };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@public-ui/solid",
3
- "version": "2.0.0-rc.8",
3
+ "version": "2.0.0",
4
4
  "license": "EUPL-1.2",
5
5
  "homepage": "https://public-ui.github.io",
6
6
  "repository": "https://github.com/public-ui/kolibri",
@@ -42,17 +42,17 @@
42
42
  "solidjs"
43
43
  ],
44
44
  "devDependencies": {
45
- "@public-ui/components": "2.0.0-rc.8",
45
+ "@public-ui/components": "2.0.0",
46
46
  "@types/minimatch": "5.1.2",
47
- "@types/minimist": "1.2.4",
48
- "@types/node": "ts5.1",
49
- "@types/normalize-package-data": "2.4.3",
50
- "solid-js": "1.8.4",
51
- "typescript": "5.2.2",
47
+ "@types/minimist": "1.2.5",
48
+ "@types/node": "ts5.3",
49
+ "@types/normalize-package-data": "2.4.4",
50
+ "solid-js": "1.8.7",
51
+ "typescript": "5.3.2",
52
52
  "unbuild": "1.2.1"
53
53
  },
54
54
  "peerDependencies": {
55
- "@public-ui/components": "2.0.0-rc.8",
55
+ "@public-ui/components": "2.0.0",
56
56
  "solid-js": ">=1.2.0"
57
57
  },
58
58
  "sideEffects": false,