@nikala-ui/core 0.12.0 → 0.12.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 +20 -0
- package/README.md +97 -20
- package/package.json +1 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Giorgi Magradze
|
|
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 QUALITY AND FITNESS FOR A PARTICULAR
|
|
17
|
+
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
18
|
+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
19
|
+
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,41 +1,118 @@
|
|
|
1
1
|
# @nikala-ui/core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@nikala-ui/core` is the internal source registry for Nikala UI. It contains the SolidJS component sources, reactive primitive manifests, application blocks, providers, metadata, and generated registry JSON used to build and publish the Nikala registry.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Nikala UI is a copy-paste component system built for SolidJS and Tailwind CSS v4. The package honors the work of Georgian painter Niko Pirosmani (Nikala).
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Documentation and interactive examples: [nikala.dev](https://nikala.dev)
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
## Role of the package
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
The core package is not a standalone application dependency. It is the canonical registry source used inside the Nikala UI monorepo, by registry generation, by the official documentation site, and by release tooling.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
End users should not install or import `@nikala-ui/core` directly. The public entry point for adding Nikala UI to an application is `@nikala-ui/cli`.
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
The normal consumer workflow is:
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
```bash
|
|
18
|
+
bunx @nikala-ui/cli init
|
|
19
|
+
bunx @nikala-ui/cli add button dialog
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
This copies editable files into the local project, usually under:
|
|
23
|
+
|
|
24
|
+
```text
|
|
25
|
+
src/components/ui/
|
|
26
|
+
src/hooks/
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Applications own the copied source files. They do not import `@nikala-ui/core` at runtime to use the generated components.
|
|
30
|
+
|
|
31
|
+
## Registry contents
|
|
32
|
+
|
|
33
|
+
The registry contains three item types:
|
|
34
|
+
|
|
35
|
+
- `registry:ui` for SolidJS UI components.
|
|
36
|
+
- `registry:hook` for reactive SolidJS primitives.
|
|
37
|
+
- `registry:block` for ready-to-use application and marketing sections.
|
|
38
|
+
|
|
39
|
+
Each registry item is represented by a JSON manifest in `registry/`. A manifest contains the item metadata, source files, internal registry dependencies, and required npm dependencies.
|
|
40
|
+
|
|
41
|
+
The package also includes the source snapshot used to generate those manifests:
|
|
42
|
+
|
|
43
|
+
```text
|
|
44
|
+
packages/core/
|
|
45
|
+
├── registry/
|
|
46
|
+
│ ├── index.json
|
|
47
|
+
│ └── *.json
|
|
48
|
+
├── src/
|
|
49
|
+
│ ├── index.ts
|
|
50
|
+
│ ├── index.css
|
|
51
|
+
│ ├── lib/
|
|
52
|
+
│ └── registry/
|
|
53
|
+
│ ├── components/ui/
|
|
54
|
+
│ ├── blocks/
|
|
55
|
+
│ ├── providers/
|
|
56
|
+
│ ├── index.ts
|
|
57
|
+
│ └── metadata.ts
|
|
58
|
+
└── scripts/
|
|
59
|
+
└── build-registry.ts
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Registry manifests
|
|
63
|
+
|
|
64
|
+
The central registry index is available at:
|
|
18
65
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
66
|
+
```text
|
|
67
|
+
registry/index.json
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Individual items can be inspected directly:
|
|
23
71
|
|
|
24
|
-
|
|
72
|
+
```text
|
|
73
|
+
registry/button.json
|
|
74
|
+
registry/create-clipboard.json
|
|
75
|
+
registry/hero-01.json
|
|
76
|
+
```
|
|
25
77
|
|
|
26
|
-
|
|
78
|
+
The manifest format allows the CLI to install only the requested item and its transitive registry dependencies. For example, a component can declare another component or hook in `registryDependencies`, while external packages are listed separately as npm dependencies.
|
|
27
79
|
|
|
28
|
-
|
|
80
|
+
## Source ownership
|
|
81
|
+
|
|
82
|
+
Source files are written for local ownership rather than as an opaque runtime UI library. After installation, developers can customize component behavior, markup, accessibility details, and styles directly in their project.
|
|
83
|
+
|
|
84
|
+
Generated sources follow Nikala UI conventions:
|
|
85
|
+
|
|
86
|
+
- SolidJS props are handled with `splitProps` to preserve reactivity.
|
|
87
|
+
- Components use semantic Tailwind CSS v4 design tokens.
|
|
88
|
+
- Browser-only behavior is guarded for SSR environments.
|
|
89
|
+
- Kobalte and Corvu are used where headless behavior and accessibility primitives are required.
|
|
90
|
+
- Components use local aliases such as `@/components/ui/*`, `@/hooks/*`, and `@/lib/*`.
|
|
91
|
+
|
|
92
|
+
## Registry generation
|
|
93
|
+
|
|
94
|
+
When component, hook, block, or metadata sources change, regenerate the manifests from the monorepo root:
|
|
29
95
|
|
|
30
96
|
```bash
|
|
31
|
-
|
|
97
|
+
bun run build:registry
|
|
32
98
|
```
|
|
33
99
|
|
|
34
|
-
|
|
100
|
+
This runs:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
cd packages/core
|
|
104
|
+
bun run build:registry
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
The generator scans the source directories, creates item manifests, writes `registry/index.json`, and synchronizes the official web application's copied sources when that workspace is present.
|
|
108
|
+
|
|
109
|
+
The registry must be regenerated before publishing changes to the core package. CI verifies that generated registry files are synchronized with the source tree.
|
|
110
|
+
|
|
111
|
+
## Related packages
|
|
35
112
|
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
-
|
|
113
|
+
- `@nikala-ui/cli` installs and updates registry items in a consuming project.
|
|
114
|
+
- `@nikala-ui/hooks` publishes the standalone reactive primitives package.
|
|
115
|
+
- `@nikala-ui/docs` bundles registry and source snapshots to initialize independent documentation projects without requiring `@nikala-ui/core` at runtime.
|
|
39
116
|
|
|
40
117
|
## License
|
|
41
118
|
|