@frame-kit/tokens 0.0.1

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 FrameKit
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,44 @@
1
+ # @frame-kit/tokens
2
+
3
+ The default **design tokens** (CSS custom properties) and **dark theme** for
4
+ [`@frame-kit/ui-ng`](https://www.npmjs.com/package/@frame-kit/ui-ng). Ship the neutral baseline as-is,
5
+ or override any `--fk-*` token to rebrand the whole component library.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm i @frame-kit/tokens
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ Load the CSS in `angular.json` → `styles` (or any global stylesheet), **before** your own overrides:
16
+
17
+ ```jsonc
18
+ "styles": [
19
+ "node_modules/@frame-kit/tokens/base.css", // default neutral theme
20
+ "node_modules/@frame-kit/tokens/dark.css", // optional — activates on prefers-color-scheme or html.dark
21
+ "src/styles.css" // YOUR overrides last → cascade wins
22
+ ]
23
+ ```
24
+
25
+ Override tokens anywhere downstream:
26
+
27
+ ```css
28
+ :root {
29
+ --fk-color-primary: #7c3aed; /* sweeping brand change */
30
+ --fk-radius-md: 4px;
31
+ }
32
+ ```
33
+
34
+ Also available:
35
+
36
+ - `@frame-kit/tokens/scss` — the source SCSS (base) for SCSS consumers; `@frame-kit/tokens/scss/dark` for dark.
37
+ - A typed token object: `import { tokens } from '@frame-kit/tokens'` (`Record<FkTokenName, string>`).
38
+
39
+ See the **[theming guide](https://github.com/frame-kit/packages/blob/main/packages/ui-ng/THEMING.md)** for the full
40
+ token contract and override recipes.
41
+
42
+ ## License
43
+
44
+ MIT