agnosticui-core 2.0.0-alpha.2 → 2.0.0-alpha.3

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 +67 -33
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -23,41 +23,75 @@ AgnosticUI uses a **Minimalist & Highly Themeable** architecture where component
23
23
 
24
24
  ```
25
25
  src/components/
26
- ├── Accordion/
27
- ├── core/
28
- ├── _Accordion.ts # Immutable core
29
- │ └── _Accordion.spec.ts # Core tests
30
- │ ├── react/
31
- │ ├── ReactAccordion.tsx # React wrapper
32
- │ │ └── useAccordion.ts # React hooks
33
- │ ├── extensions/
34
- └── AnimatedAccordion.ts # Enhanced version
35
- │ ├── styled/
36
- │ │ └── MinimalAccordion.ts # Pre-styled variants
37
- ├── helpers/
38
- │ │ └── accordion-state.ts # Shared utilities
39
- │ └── Accordion.ts # Public exports
26
+ └── Accordion/
27
+ ├── core/
28
+ │ ├── _Accordion.ts # Core Lit Component
29
+ ├── Accordion.ts # Public interface
30
+ │ ├── AccordionGroup.ts # Group component
31
+ └── README.md # Documentation
32
+ ├── react/
33
+ │ ├── index.ts # React exports
34
+ │ └── ReactAccordion.tsx # React wrapper
35
+ └── vue/
36
+ ├── index.ts # Vue exports
37
+ ├── VueAccordion.vue # Main component
38
+ ├── VueAccordionContent.vue # Content component
39
+ ├── VueAccordionHeader.vue # Header component
40
+ └── VueAccordionItem.vue # Item component
40
41
  ```
41
42
 
42
- ## Key Principles
43
-
44
- ### Minimalist & Highly Themeable Philosophy
45
- - **Minimal Visual Styling**: Clean defaults via `--ag-*` design tokens
46
- - ✅ **Functional CSS**: Layout, positioning, component structure
47
- - 🎨 **Complete Customization**: Override any design token for white-labeling
48
- - 🎯 **Result**: Production-ready components with enterprise-grade theming
49
-
50
- ### Upgrade Safety: Encapsulated Core with Adapter Pattern
51
- - **Immutable Core**: `_Component.ts` files are canonical and upgrade-safe
52
- - **Adapter Layer**: Framework wrappers absorb breaking changes between versions
53
- - **Isolated Customization**: Extensions and styled variants evolve independently
54
- - **Safe Overrides**: Customize via design tokens without touching core implementations
55
- - **Result**: Your customizations survive library upgrades seamlessly
56
-
57
- ### Framework Agnostic
58
- - Web Components work in any framework
59
- - Framework-specific wrappers provide optimal DX
60
- - Progressive enhancement from vanilla JS to framework-specific features
43
+ ## Why AgnosticUI?
44
+
45
+ ### The Local UI Kit - A New Category
46
+ **The UI kit that lives in your codebase, not node_modules.**
47
+
48
+ Traditional UI libraries live in `node_modules/` as black boxes. Copy/paste approaches give you code but no reference. AgnosticUI Local gives you **both**: a complete reference library in your project plus owned copies of components you use.
49
+
50
+ ```bash
51
+ npx ag init # Full library in ./agnosticui/ (reference)
52
+ npx ag add button # Component in ./src/components/ag/ (yours to modify)
53
+ npx ag sync # Update reference, preserve your customizations
54
+ ```
55
+
56
+ ### AI-First Development
57
+ **The only UI kit designed for AI-assisted development.**
58
+
59
+ - **Full Context**: AI tools (Cursor, Windsurf, Claude) see your entire component library
60
+ - **Better Assistance**: "Make this button work like the Combobox" - AI sees both
61
+ - **Reference + Customization**: AI understands the source AND your modifications
62
+ - **Offline & Local**: No API calls, no rate limits, no black boxes
63
+
64
+ ### Complete Ownership
65
+ **Copy, modify, and own your components.**
66
+
67
+ - Components copied to your project - modify structure, behavior, styling
68
+ - No vendor lock-in or "black box" frustration
69
+ - You control the dependency graph and update schedule
70
+ - Review diffs before accepting updates via `npx ag sync`
71
+
72
+ ### Zero Dependencies
73
+ **Only Lit (5KB runtime) - nothing else.**
74
+
75
+ - No bloated node_modules
76
+ - Components work standalone
77
+ - Production bundle includes only what you use
78
+ - Framework wrappers via @lit/react and Vue 3 composition API
79
+
80
+ ### Minimalist & Themeable
81
+ **Beautiful defaults, infinite customization.**
82
+
83
+ - Production-ready styling out of the box
84
+ - Everything customizable via `--ag-*` design tokens
85
+ - Enterprise white-labeling capability
86
+ - Light/dark mode built-in
87
+
88
+ ### Multi-Framework Support
89
+ **React, Vue, Lit - one component library, all frameworks.**
90
+
91
+ - Framework-specific wrappers for optimal developer experience
92
+ - React wrapper via @lit/react makes props and events feel naturally "React-like"
93
+ - Vue 3 components using composition API
94
+ - Svelte works directly (excellent Web Components support)
61
95
 
62
96
  ## Usage
63
97
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agnosticui-core",
3
- "version": "2.0.0-alpha.2",
3
+ "version": "2.0.0-alpha.3",
4
4
  "type": "module",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.esm.js",