Comments (4)
I simply will start redirecting people to a library that takes another approach:
Upside: all will work with TypeScript.
Downside: Adding a description to a slot and its bindings is impossible.
from vue-styleguidist.
I really like how flexible vue-docgen-api is. Using vue-compoenent-meta will mean that I will need to use both. But in any case, thank you for the pointer.
Edit: I just saw this PR got merged. I'll give it another try.
Edit 2: It didn't work
from vue-styleguidist.
@elevatebart with the PR above actually works. The docgen was able to extract the documentation when I imported the types separately but it didn't work when I imported all of them. Here are examples, in case there is an easy fix:
// works
import type { Props } from './Component.types';
const props = withDefaults(defineProps<Props>(), { size: 'medium' })
// doesn't work
import type * as T from './Component.types';
const props = withDefaults(defineProps<T.Props>(), { size: 'medium' })
from vue-styleguidist.
OOOh I understand !!
Well yeah that should be possible. I am going to create a quick repro on a branch, see what I can do.
from vue-styleguidist.
Related Issues (20)
- Extract slot and property documentation from `defineSlots` HOT 1
- [vue-docgen-api] Events defined in short `defineEmits` form are ignored HOT 2
- SetupOptionsHandler Comment error HOT 1
- Trouble with Vue 2 + Typescript + Nuxt HOT 2
- Yarn issue: YN0002: vue-docgen-api@npm:4.74.1 doesn't provide vue (pde4ae), requested by vue-inbrowser-compiler-independent-utils HOT 5
- Document component self not working
- vue-docgen-cli + vue3: jsdoc not working HOT 2
- vue-docgen-cli: Line breaks should behave predictably
- Does vue-styleguidist support template refs? HOT 1
- vue-docgen-cli: Template util mdclean, escape arrow brackets in code HOT 3
- Is it possible to get type description string like TypeScript type HOT 2
- `defineModels` macro support HOT 1
- How to document slots when using jsx HOT 1
- Cannot read property '_t' of undefined" HOT 1
- how can use vue-docgen-api in vue3 with .tsx HOT 5
- Resolving import to radix-vue type fails HOT 3
- Docgen fails to resolve radix-vue module HOT 2
- Document data,computed ? HOT 2
- cite
- Custom blocks with markdown not working vith Vite HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from vue-styleguidist.