@dpa-id-components/dpa-shared-components 0.3.1 → 0.4.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 (7) hide show
  1. package/README.md +35 -30
  2. package/dist/dpa-shared-components.d.ts +48 -0
  3. package/dist/dpa-shared-components.mjs +1821 -1848
  4. package/dist/dpa-shared-components.umd.js +3 -3
  5. package/dist/shims-vue.d.ts +6 -0
  6. package/dist/style.css +1 -1
  7. package/package.json +3 -1
package/README.md CHANGED
@@ -28,6 +28,17 @@ module.exports = {
28
28
  };
29
29
  ```
30
30
 
31
+ The tailwind config is located at `./src/tailwind/tailwind.config.cjs`.
32
+ Please be aware that used plugins must be listed in the dependencies or the projects using the components have to
33
+ install it.
34
+
35
+ For correct styling you also need to import the ``style.css`` from the package somwhere at root of your project (e.g.
36
+ App.js)
37
+
38
+ ```JavaScript
39
+ import "@dpa-id-components/dpa-shared-components/style.css";
40
+ ```
41
+
31
42
  ## Add a component
32
43
 
33
44
  To add a new component please add at least the following files:
@@ -41,32 +52,6 @@ The readme should contain a minimal explanation of the usage and a definition of
41
52
  events, slots...).
42
53
  Also don't forget to add an import/export in `./src/components/index.ts` to make your component available.
43
54
 
44
- ### Link the project locally
45
-
46
- For a better developer experience and testing in your actual it's recommended
47
- to [link](https://docs.npmjs.com/cli/v9/commands/npm-link) the package locally.
48
- For that run
49
-
50
- ```shell
51
- npm link
52
- ```
53
-
54
- in the root of your cloned shared components and
55
-
56
- ```shell
57
- npm link "@dpa-id-components/dpa-shared-components"
58
- ```
59
-
60
- in your target project.
61
-
62
- Don't forget to run
63
-
64
- ```shell
65
- npm run build
66
- ```
67
-
68
- before linking or otherwise you wouldn't have a dist folder.
69
-
70
55
  ### Tests
71
56
 
72
57
  Tests are based on [vitest](https://vitest.dev/) and [Vue Test Utils 2](https://test-utils.vuejs.org/) running in
@@ -93,11 +78,31 @@ npm run storybook
93
78
 
94
79
  A deployed version of the storybook can be found [here](https://dpa-gmbh.github.io/dpa-shared-components/).
95
80
 
96
- ## Tailwind
81
+ ### Link the project locally
97
82
 
98
- The tailwind config is located at `./src/tailwind/tailwind.config.cjs`.
99
- Please be aware that used plugins must be listed in the dependencies or the projects using the components have to
100
- install it.
83
+ For a better developer experience and testing in your actual it's recommended
84
+ to [link](https://docs.npmjs.com/cli/v9/commands/npm-link) the package locally.
85
+ For that run
86
+
87
+ ```shell
88
+ npm link
89
+ ```
90
+
91
+ in the root of your cloned shared components and
92
+
93
+ ```shell
94
+ npm link "@dpa-id-components/dpa-shared-components"
95
+ ```
96
+
97
+ in your target project.
98
+
99
+ Don't forget to run
100
+
101
+ ```shell
102
+ npm run build
103
+ ```
104
+
105
+ before linking or otherwise you wouldn't have a dist folder.
101
106
 
102
107
  ## SVG icons
103
108
 
package/dist/dpa-shared-components.d.ts ADDED
@@ -0,0 +1,48 @@
1
+ import type { AllowedComponentProps } from 'vue';
2
+ import type { ComponentCustomProps } from 'vue';
3
+ import type { ComponentOptionsMixin } from 'vue';
4
+ import type { DefineComponent } from 'vue';
5
+ import type { ExtractPropTypes } from 'vue';
6
+ import type { VNodeProps } from 'vue';
7
+
8
+ export declare const UiBadge: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
9
+
10
+ export declare const UiButton: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
11
+
12
+ export declare const UiCard: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
13
+
14
+ export declare const UiCheckbox: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
15
+
16
+ export declare const UiChip: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
17
+
18
+ export declare const UiDialog: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
19
+
20
+ export declare const UiFilterBadge: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
21
+
22
+ export declare const UiFilterButton: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
23
+
24
+ export declare const UiIcon: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
25
+
26
+ export declare const UiIconButton: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
27
+
28
+ export declare const UiInput: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
29
+
30
+ export declare const UiList: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
31
+
32
+ export declare const UiListItem: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
33
+
34
+ export declare const UiOverlay: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
35
+
36
+ export declare const UiOverlayMenu: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
37
+
38
+ export declare const UiSearchInput: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
39
+
40
+ export declare const UiSection: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
41
+
42
+ export declare const UiSkeletonBox: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
43
+
44
+ export declare const UiSpinner: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
45
+
46
+ export declare const UiToggleButton: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
47
+
48
+ export { }