Skip to content

Commit 9d83f92

Browse files
committed
docs(readme): clarify supported Vue API styles and data origins
1 parent ca7d67a commit 9d83f92

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
<img src="https://github.com/vofronte/vue-glimpse/blob/main/media/demo.gif?raw=true" alt="VueGlimpse in action (demo)">
2525
</p>
2626

27-
VueGlimpse is a VS Code extension for **Vue & Nuxt** that ends the constant scrolling and context-switching when working in large components. It shows you exactly where your template variables originate—be it `props`, `ref`, a `store`, or a local `const`—with subtle, at-a-glance icons, and provides clean, context-aware tooltips on hover. Stay in your flow and understand your component's data source instantly.
27+
VueGlimpse is a VS Code extension for **Vue & Nuxt** that ends the constant scrolling and context-switching when working in large components. It shows you exactly where your template variables originate—be it `props`, a `store`, or a computed property—with subtle, at-a-glance icons. It supports both **`<script setup>` (Composition API)** and the **Options API**, helping you stay in your flow and understand your component's data source instantly.
2828

2929
## Table of Contents
3030

@@ -39,20 +39,21 @@ VueGlimpse is a VS Code extension for **Vue & Nuxt** that ends the constant scro
3939

4040
You're deep in a component, see `<p>{{ user.name }}</p>`, and ask yourself:
4141

42-
> "Where is `user` coming from? Is it a `prop`? A `ref`? From a Pinia store?"
42+
> "Where is `user` coming from? Is it a `prop`? A `ref`? From a Pinia store? Or a `data` property?"
4343
44-
Each question forces a jump to the `<script setup>`, breaking your concentration. VueGlimpse eliminates these interruptions.
44+
Each question forces a jump to the `<script>` block, breaking your concentration. VueGlimpse eliminates these interruptions.
4545

4646
- 🧠 **Reduces Cognitive Load:** Stop mapping your component's state in your head. The editor does it for you.
4747
-**Keeps You in the Flow:** Stay focused on your template without constant context switching.
48-
- 🚀 **Speeds Up Onboarding & Reviews:** Instantly understand an unfamiliar component's data flow.
48+
- 🚀 **Speeds Up Onboarding & Reviews:** Instantly understand any component's data flow, regardless of the API style.
4949

5050
## Features
5151

5252
- **At-a-glance Origin Indicators:** Subtle icons in your template tell you the source of your data.
53-
- **Minimalist Hovers:** Instantly identify a variable's origin (`Prop`, `Ref`, etc.) on hover-no code, just context.
54-
- **Compiler-Level Accuracy:** Powered by `@vue/compiler-sfc` for guaranteed correctness.
55-
- **Full API Visibility:** Identifies the entire Vue Composition API, including stores and passthrough attributes.
53+
- **Universal API Support:** Works seamlessly with both `<script setup>` and the Options API.
54+
- **Minimalist Hovers:** Instantly identify a variable's origin (`Prop`, `Ref`, etc.) on hover—no code, just context.
55+
- **Compiler-Level Accuracy:** Powered by `@vue/compiler-sfc` for guaranteed correctness where possible.
56+
- **Full API Visibility:** Identifies the entire Vue API surface, including stores and passthrough attributes.
5657
- **Blazing Fast:** Intelligent caching ensures zero performance impact.
5758
- **Configurable:** Toggle icons and hovers to fit your workflow.
5859

@@ -62,15 +63,15 @@ A simple, intuitive icon set helps you decode your template instantly.
6263

6364
| Icon | Origin | What It Means |
6465
| :--: | --------------------------- | ------------------------------------------------------------ |
65-
|| `prop` | Data passed down from a parent (`defineProps`). |
66-
| 📥 | `attrs` / `slots` | Attributes or slots passed from a parent that are not declared as props. Available via `$attrs`, `$slots`, `useAttrs()`, or `useSlots()`. |
67-
| 📤 | `emit` | An event sent to a parent component. Available via `defineEmits()` or the built-in `$emit`. |
68-
| 🔹 | `ref` | A reactive primitive value (`ref()`). |
69-
| 🔷 | `reactive` | A reactive object (`reactive()`). |
70-
|| `computed` | A derived value that updates automatically (`computed()`). |
71-
| 📦 | `store` / External State | State from a global store like Pinia or Vuex. |
72-
| ƒ | `method` | A function you can call. |
73-
|| Local Variable | A simple, non-reactive `const` or `let`. |
66+
|| `prop` | Data passed down from a parent (`defineProps` or `props` option). |
67+
| 📥 | `attrs` / `slots` | Attributes or slots passed from a parent. Available via `$attrs`, `$slots`, etc. |
68+
| 📤 | `emit` | An event sent to a parent component. Available via `defineEmits` or `$emit`. |
69+
| 🔹 | `ref` | A reactive primitive value (`ref()` in `<script setup>`). |
70+
| 🔷 | `reactive` | A reactive object (`reactive()` or a `data()` property). |
71+
|| `computed` | A derived value that updates automatically (`computed` option or function). |
72+
| 📦 | `store` / External State | State from a global store like Pinia or Vuex. |
73+
| ƒ | `method` | A function you can call from the template (`methods` option or a function in `<script setup>`). |
74+
|| Local Variable | A simple, non-reactive `const` or `let` in `<script setup>`. |
7475

7576
## Getting Started
7677

0 commit comments

Comments
 (0)