@db-ux/core-components 3.1.3 → 3.1.4
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.
- package/README.md +12 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -23,10 +23,21 @@ For additional information besides the frameworks see our [Getting started](http
|
|
|
23
23
|
|
|
24
24
|
If you just need the styling follow this:
|
|
25
25
|
|
|
26
|
+
## Package Relationship
|
|
27
|
+
|
|
28
|
+
**✅ Do I need foundations if I install components?**
|
|
29
|
+
|
|
30
|
+
**No!** The `@db-ux/core-components` package **automatically includes** all the foundations (`@db-ux/core-foundations`) you need. You only need to install one package:
|
|
31
|
+
|
|
32
|
+
- **Use `@db-ux/core-components`** - If you want to use UI components (buttons, inputs, etc.)
|
|
33
|
+
- **Use `@db-ux/core-foundations`** - If you only need design tokens, colors, spacing, fonts, and assets without any component styles
|
|
34
|
+
|
|
26
35
|
## Install
|
|
27
36
|
|
|
28
37
|
`npm i @db-ux/core-components`
|
|
29
38
|
|
|
39
|
+
> **Note**: This automatically includes `@db-ux/core-foundations` as a dependency, so you don't need to install it separately.
|
|
40
|
+
|
|
30
41
|
## Styling Dependencies
|
|
31
42
|
|
|
32
43
|
Import the styles in `scss` or `css`. Based on your technology the file names could be different.
|
|
@@ -35,7 +46,7 @@ Import the styles in `scss` or `css`. Based on your technology the file names co
|
|
|
35
46
|
- `webpack`: asset path point to `~@db-ux/core-foundations/assets`
|
|
36
47
|
- `rollup`: asset path point to `@db-ux/core-foundations/assets`
|
|
37
48
|
|
|
38
|
-
|
|
49
|
+
**Important**: These bundled files automatically include **all dependencies from [foundations](https://www.npmjs.com/package/@db-ux/core-foundations)** (design tokens, colors, fonts, etc.) **and all [components](https://github.com/db-ux-design-system/core-web/blob/main/packages/components/src/styles/db-ux-components.scss)** - everything you need in one import!
|
|
39
50
|
|
|
40
51
|
**SCSS**
|
|
41
52
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@db-ux/core-components",
|
|
3
|
-
"version": "3.1.
|
|
3
|
+
"version": "3.1.4",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "",
|
|
6
6
|
"repository": {
|
|
@@ -42,13 +42,13 @@
|
|
|
42
42
|
"start": "nodemon --watch src --watch scripts --watch scripts --ext js,tsx,ts,scss,json --exec \"npm run build\""
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
|
-
"@db-ux/core-foundations": "3.1.
|
|
45
|
+
"@db-ux/core-foundations": "3.1.4"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
48
|
"@builder.io/eslint-plugin-mitosis": "0.0.17",
|
|
49
49
|
"@builder.io/mitosis": "0.12.1",
|
|
50
50
|
"@builder.io/mitosis-cli": "0.12.1",
|
|
51
|
-
"@typescript-eslint/eslint-plugin": "8.
|
|
51
|
+
"@typescript-eslint/eslint-plugin": "8.44.0",
|
|
52
52
|
"cpr": "3.0.1",
|
|
53
53
|
"cssnano": "7.1.1",
|
|
54
54
|
"hygen": "6.2.11",
|