Giter Club home page Giter Club logo

Comments (4)

elevatebart avatar elevatebart commented on May 27, 2024

I simply will start redirecting people to a library that takes another approach:

vue-component-meta

Upside: all will work with TypeScript.
Downside: Adding a description to a slot and its bindings is impossible.

from vue-styleguidist.

sevilyilmaz avatar sevilyilmaz commented on May 27, 2024

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.

sevilyilmaz avatar sevilyilmaz commented on May 27, 2024

@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.

elevatebart avatar elevatebart commented on May 27, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.