@pantograph/vue 0.35.6 → 0.35.8
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/README.md +19 -27
- package/dist/index.d.ts +547 -318
- package/dist/index.js +1 -1
- package/dist/index.umd.cjs +1 -1
- package/dist/nuxt.d.ts +98 -98
- package/dist/resolver.d.ts +98 -98
- package/dist/use/index.js +8934 -8976
- package/dist/use/index.umd.cjs +7 -7
- package/dist/use.d.ts +98 -98
- package/package.json +6 -16
package/README.md
CHANGED
|
@@ -1,50 +1,42 @@
|
|
|
1
|
-
<p align="center">
|
|
2
|
-
<img src="./public/logo.svg" alt="Pantograph Logo" width="160" />
|
|
3
|
-
</p>
|
|
4
|
-
|
|
5
1
|
# @pantograph/vue
|
|
6
2
|
|
|
7
|
-
|
|
3
|
+
The core Vue 3 component library for the Pantograph design system. Provides 80+ WAI-ARIA accessible, themeable, and tree-shakeable UI components built on top of `reka-ui`.
|
|
8
4
|
|
|
9
|
-
##
|
|
5
|
+
## Installation
|
|
10
6
|
|
|
11
7
|
```bash
|
|
12
8
|
npm i @pantograph/vue
|
|
13
9
|
```
|
|
14
10
|
|
|
15
|
-
## Quick
|
|
11
|
+
## Quick Usage
|
|
16
12
|
|
|
17
13
|
```vue
|
|
18
14
|
<script setup lang="ts">
|
|
19
|
-
import { Button } from '@pantograph/vue'
|
|
15
|
+
import { Button, Input, Modal } from '@pantograph/vue'
|
|
20
16
|
import '@pantograph/styles'
|
|
21
17
|
</script>
|
|
22
18
|
|
|
23
19
|
<template>
|
|
24
|
-
<Button variant="primary">
|
|
20
|
+
<Button variant="primary">Get Started</Button>
|
|
21
|
+
<Input placeholder="Enter your email" />
|
|
22
|
+
<Modal v-model:open="isOpen">
|
|
23
|
+
<template #header>Modal Title</template>
|
|
24
|
+
<p>Modal content goes here.</p>
|
|
25
|
+
</Modal>
|
|
25
26
|
</template>
|
|
26
27
|
```
|
|
27
28
|
|
|
28
29
|
## Key Features
|
|
29
30
|
|
|
30
31
|
- **80+ WAI-ARIA components** built on top of `reka-ui` for robust accessibility
|
|
31
|
-
- **Base → Public pattern**: Internal
|
|
32
|
-
- **CSS-in-JS
|
|
33
|
-
- **Dark mode**:
|
|
34
|
-
- **
|
|
35
|
-
- **Strict exports**: Named exports only; no default exports and no subpath imports (e.g., `@pantograph/vue/Button` is not allowed)
|
|
36
|
-
- **Component structure**: Each component follows a standardized layout: `.vue` + `index.ts` + `types.ts` + `constant.ts` + `model.ts` + `context.ts`
|
|
37
|
-
|
|
38
|
-
## Navigation
|
|
39
|
-
|
|
40
|
-
For a complete map of all packages, components, and import paths, refer to the centralized navigation index:
|
|
41
|
-
- [`.ai/NAVIGATION.md`](../../.ai/NAVIGATION.md)
|
|
42
|
-
|
|
43
|
-
## Documentation
|
|
32
|
+
- **Base → Public pattern**: Internal primitives (`BaseButton`) styled and wrapped into public components (`Button`)
|
|
33
|
+
- **CSS-in-JS option**: Dynamic style loading via `useCssInJs` from `useConfig()`
|
|
34
|
+
- **Dark mode support**: Class-based toggling (`pantograph-dark` / `pantograph-light`) on the root element
|
|
35
|
+
- **Strict exports**: Named exports only (subpath imports like `@pantograph/vue/Button` are disallowed)
|
|
44
36
|
|
|
45
|
-
|
|
37
|
+
## Documentation & Resources
|
|
46
38
|
|
|
47
|
-
-
|
|
48
|
-
-
|
|
49
|
-
-
|
|
50
|
-
-
|
|
39
|
+
- [Monorepo Architecture Layout](../../../.ai/architecture.md)
|
|
40
|
+
- [Engineering Guidelines](../../../ENGINEERING_GUIDELINES.md)
|
|
41
|
+
- [AI Navigation Map](../../../.ai/NAVIGATION.md)
|
|
42
|
+
- Component Contracts: [.ai/component-contracts/vue.json](../../../.ai/component-contracts/vue.json)
|