@pantograph/vue 0.35.7 → 0.35.9

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 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
- Pantograph's Vue 3 component library, built with TypeScript and token-based design. Ready to use in your apps with light/dark token switching and simple, consistent APIs.
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
- ## Install
5
+ ## Installation
10
6
 
11
7
  ```bash
12
8
  npm i @pantograph/vue
13
9
  ```
14
10
 
15
- ## Quick usage
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">Click me</Button>
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 base components (e.g., `BaseButton`) are wrapped and styled into public Pantograph components (e.g., `Button`)
32
- - **CSS-in-JS styling**: Style imports are handled via `useCssInJs` from `useConfig()` — no `<style>` tags required for component styling
33
- - **Dark mode**: Activated via CSS class (`pantograph-dark` or `pantograph-light`) on the root element; never uses `.dark` CSS rules
34
- - **Token system**: All CSS variables use the `--pt-*` prefix for consistent theming
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
- For full documentation and live examples, visit the Pantograph docs:
37
+ ## Documentation & Resources
46
38
 
47
- - Docs: [Introduction & Stories](https://panto.stg.bounteco.com/story/src-story-introduction-story-js)
48
- - Component APIs: [`.ai/component-contracts.json`](../../.ai/component-contracts.json)
49
- - Import paths: [`.ai/symbol-map.json`](../../.ai/symbol-map.json)
50
- - Run `npm run ai:index` to regenerate indexes after structural changes
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)