@openfin/here-ui-css 0.0.0-alpha.20251106164724

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 (2) hide show
  1. package/README.md +77 -0
  2. package/package.json +37 -0
package/README.md ADDED
@@ -0,0 +1,77 @@
1
+ # @here/here-ui-css
2
+
3
+ CSS-only distribution of `@openfin/ui-library` components.
4
+
5
+ ## Purpose
6
+
7
+ This package provides compiled CSS styles from `@openfin/ui-library` as a standalone distribution. It allows you to use the component styles without the React component implementations, making it ideal for:
8
+
9
+ - Non-React applications
10
+ - Custom implementations using the same visual design
11
+ - Static HTML projects
12
+
13
+ ## Installation
14
+
15
+ ```bash
16
+ npm install @here/here-ui-css
17
+ ```
18
+
19
+ ## Import Patterns
20
+
21
+ ### All-in (Default)
22
+
23
+ Import all component styles at once:
24
+
25
+ ```css
26
+ @import '@here/here-ui-css';
27
+ ```
28
+
29
+ ```javascript
30
+ import '@here/here-ui-css';
31
+ ```
32
+
33
+ ### Per-file Subpaths
34
+
35
+ Import individual component styles using any path under `dist/`:
36
+
37
+ ```css
38
+ @import '@here/here-ui-css/styles/enterpriseTab.css';
39
+ ```
40
+
41
+ ```javascript
42
+ import '@here/here-ui-css/styles/enterpriseTab.css';
43
+ ```
44
+
45
+ The package uses [subpath patterns](https://nodejs.org/api/packages.html#subpath-patterns), so you can import **any CSS file** from the `dist/` directory without needing to manually maintain exports in `package.json`. As new CSS files are added to the UI library, they automatically become importable!
46
+
47
+ ## Versioning
48
+
49
+ This package's version tracks `@openfin/ui-library`. When `@openfin/ui-library` is published, this package is published with the same version number to ensure style compatibility.
50
+
51
+ ## Building
52
+
53
+ This package's build process depends on a completed `@openfin/ui-library` build:
54
+
55
+ ```bash
56
+ # 1. Build the UI Library first (from workspace root)
57
+ npm run build:ui
58
+
59
+ # 2. Then build the CSS package (from packages/here-ui-css)
60
+ npm run build
61
+ ```
62
+
63
+ The build script will:
64
+
65
+ 1. Clean the `dist/` directory
66
+ 2. Copy all CSS files from `@openfin/ui-library/dist/` to `dist/`
67
+ 3. Generate `dist/index.css` that imports all CSS files in deterministic order
68
+
69
+ If the UI Library hasn't been built yet, the build will fail with a clear error message.
70
+
71
+ ## Source
72
+
73
+ The CSS files in this package are compiled outputs. The source SCSS/CSS files live in the `@openfin/ui-library` package at `packages/ui-library/src/styles/`. Any modifications should be made there.
74
+
75
+ ## License
76
+
77
+ SEE LICENSE IN LICENSE.MD
package/package.json ADDED
@@ -0,0 +1,37 @@
1
+ {
2
+ "name": "@openfin/here-ui-css",
3
+ "version": "0.0.0-alpha.20251106164724",
4
+ "description": "CSS-only distribution of @openfin/ui-library components",
5
+ "main": "dist/index.css",
6
+ "style": "dist/index.css",
7
+ "private": false,
8
+ "publishConfig": {
9
+ "access": "public",
10
+ "registry": "https://registry.npmjs.org/"
11
+ },
12
+ "repository": {
13
+ "type": "git",
14
+ "url": "git+https://github.com/openfin/workspace.git",
15
+ "directory": "packages/here-ui-css"
16
+ },
17
+ "files": [
18
+ "dist/**/*"
19
+ ],
20
+ "exports": {
21
+ ".": {
22
+ "default": "./dist/index.css"
23
+ },
24
+ "./*": "./dist/*"
25
+ },
26
+ "sideEffects": [
27
+ "**/*.css"
28
+ ],
29
+ "license": "SEE LICENSE IN LICENSE.MD",
30
+ "scripts": {
31
+ "clean": "rimraf dist",
32
+ "build": "node scripts/build.js"
33
+ },
34
+ "devDependencies": {
35
+ "rimraf": "^5.0.0"
36
+ }
37
+ }