You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-2Lines changed: 18 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,11 +32,27 @@ designers, and content authors build, maintain, and scale best-of-class digital
32
32
|[@db-ux/v-core-components](https://github.com/db-ux-design-system/core-web/tree/main/output/vue)| Native Vue 3 components |[](https://npmjs.com/package/@db-ux/v-core-components"DB UX Design System – on NPM")|
33
33
|[@db-ux/wc-core-components](https://github.com/db-ux-design-system/core-web/tree/main/output/stencil)| Web Components |[](https://npmjs.com/package/@db-ux/wc-core-components"DB UX Design System – on NPM")|
34
34
35
+
### Which package should I choose?
36
+
37
+
**For JavaScript framework-specific components**: Choose your framework package (React, Angular, Vue, Web Components) which includes styling and JavaScript behavior.
38
+
39
+
**For other users**: Use `@db-ux/core-components` - it includes everything you need (foundations + component styles).
40
+
41
+
**For design tokens only**: Use `@db-ux/core-foundations` if you only need colors, spacing, fonts, and icons without pre-built component styles.
42
+
35
43
## How to use
36
44
37
-
Install your preferred package via npm or yarn e.g. `npm i @db-ux/react-core-components`.
45
+
1.**Install your preferred package** via npm or yarn:
46
+
- For React: `npm i @db-ux/react-core-components`
47
+
- For Angular: `npm i @db-ux/ngx-core-components`
48
+
- For Vue: `npm i @db-ux/v-core-components`
49
+
- For Web Components: `npm i @db-ux/wc-core-components`
50
+
- For styling only: `npm i @db-ux/core-components`
51
+
52
+
2.**Include the CSS styles** as described in the "Styling Dependencies" section of each package's `README`.
53
+
54
+
> **💡 Note**: All framework packages automatically include the necessary foundation styles - you don't need to install `@db-ux/core-foundations` separately!
38
55
39
-
Afterwards, you need to include the specific CSS or SCSS files to apply the styles of DB UX Design System (Version 3), as described in the "Styling Dependencies" section of each package's `README`.
40
56
We even provide some [examples of integrations](https://github.com/db-ux-design-system/examples).
Copy file name to clipboardExpand all lines: packages/components/README.md
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -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
-
They are bundling all dependencies from [foundations](https://www.npmjs.com/package/@db-ux/core-foundations)and all [components](https://github.com/db-ux-design-system/core-web/blob/main/packages/components/src/styles/db-ux-components.scss) available.
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!
Copy file name to clipboardExpand all lines: packages/foundations/README.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,19 @@
7
7
8
8
A library containing all tokens (colors, spacings, font formatting, etc.) and assets (icons) of [DB UX Design System v3](https://github.com/db-ux-design-system/core-web).
9
9
10
+
## When to use this package
11
+
12
+
**⚠️ Looking for UI components?** You probably want [`@db-ux/core-components`](https://www.npmjs.com/package/@db-ux/core-components) instead, which **automatically includes** this package.
13
+
14
+
**Use this package when you:**
15
+
- Only need design tokens (colors, spacing, fonts) without any component styles
16
+
- Want to build custom components using the design system tokens
17
+
- Need just icons and fonts without pre-built components
18
+
19
+
**Use [`@db-ux/core-components`](https://www.npmjs.com/package/@db-ux/core-components) when you:**
20
+
- Want to use ready-made UI components (buttons, inputs, navigation, etc.)
21
+
- Need both design tokens AND component styles (most common use case)
0 commit comments