@db-ui/components - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

package.json

 {
   "name": "@db-ui/components",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "",
@@ -32,18 +32,19 @@ "author": "",
     "generate:component": "hygen mitosis new",
+    "generate:docs": "hygen update-docs new",
     "start": "nodemon --watch src --watch scripts --watch overrides -e js,tsx,ts,scss,json -x \"npm run build\""
   },
   "dependencies": {
-    "@db-ui/foundations": "0.0.5"
+    "@db-ui/foundations": "0.0.6"
   },
   "devDependencies": {
     "@builder.io/eslint-plugin-mitosis": "^0.0.14",
-    "@builder.io/mitosis": "^0.0.93",
-    "@builder.io/mitosis-cli": "^0.0.52",
+    "@builder.io/mitosis": "^0.0.96",
+    "@builder.io/mitosis-cli": "^0.0.55",
     "@react-docgen/cli": "^1.0.0-alpha.1",
     "cpr": "3.0.1",
-    "eslint": "^8.37.0",
+    "eslint": "^8.38.0",
     "hygen": "^6.2.11",
-    "lit": "^2.7.0",
+    "lit": "^2.7.2",
     "nodemon": "2.0.22",
-    "sass": "^1.60.0"
+    "sass": "^1.61.0"
   },
@@ -50,0 +51,0 @@ "publishConfig": {

README.md

@@ -10,3 +10,3 @@ # @db-ui/components
 
-We currently support:
+We currently support additional JavaScript frameworks:
 
@@ -18,3 +18,57 @@ -   [Angular components](https://www.npmjs.com/package/@db-ui/ngx-components)
 Please look at your desired framework to retrieve more information.
+If you just need the styling follow this:
 
+## Install
+
+`npm i @db-ui/components`
+
+## Dependencies (simple)
+
+Import the styles in `scss` or `css`. Based on your technology the file names could be different.
+
+-   Default (db-ui-42): asset path point to `../assets`
+-   Webpack (db-ui-42-webpack): asset path point to `~@db-ui/foundations/assets`
+-   Rollup (db-ui-42-rollup): asset path point to `@db-ui/foundations/assets`
+
+**SCSS**
+
+```scss
+// index.scss
+@use "@db-ui/components/build/styles/db-ui-42-rollup" as *;
+```
+
+**CSS**
+
+Within HTML files directly:
+
+```html
+// index.html
+<link rel="stylesheet" href="/styles/db-ui-42.css">
+```
+
+Or within your JavaScript files, with the related bundler as a prefix (in this case rollup and equivalents like Vite):
+
+```js
+// main.js
+import "@db-ui/components/build/styles/db-ui-42-rollup.css";
+```
+
+## Dependencies (advanced)
+
+**SCSS**
+
+```scss
+@use "@db-ui/foundations/build/scss/rollup.assets-paths" as *;
+@use "@db-ui/foundations/build/scss/icon/icons" as *;
+@use "@db-ui/foundations/build/scss/db-ui-foundations" as *;
+```
+
+**CSS**
+
+```js
+// main.js
+import "@db-ui/foundations/build/css/icon/icons.css";
+import "@db-ui/foundations/build/css/db-ui-foundations.css";
+```
+
 ## Deutsche Bahn brand
@@ -21,0 +75,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1009059

increased by2.36%

Lines of code

23422

increased by0.71%

Number of lines in readme file

91

increased by145.95%

Dependency changes

• + Added@db-ui/foundations@0.0.6(transitive)

• - Removed@db-ui/foundations@0.0.5(transitive)

• Updated@db-ui/foundations@0.0.6