Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

vue-docgen-cli: Event template doesn't show @property tags

See original GitHub issue

The problem

The event template shows events with:

Event name
Type
Description

Properties, the value(s) returned with the event, are not shown anywhere.

Proposed solution

Add a column with @property information, similar to @binding.

Alternative solutions

Override the template in the config (templates option).

Additional context

With the comment:

/**
 * Return the new value as boolean.
 *
 * @type {change}
 * @property {boolean} val current value of control
 */

This gets displayed as:

Screen Shot 2020-11-11 at 1 44 07 PM

Issue Analytics

State:
Created 3 years ago
Comments:10 (5 by maintainers)

Top GitHub Comments

1reaction

elevatebartcommented, Nov 11, 2020

I am really thinking of removing the @type from events in next major version

0reactions

CaitlinWeb-stcommented, Nov 30, 2020

@elevatebart Thanks for the update on this in v4.33.10! 😀 I tried it out with v4.34.1 and it’s excellent!

Top Results From Across the Web

vue-docgen-cli: Event template doesn't show @property tags

The problem. The event template shows events with: Event name; Type; Description. Properties, the value(s) returned with the event, are not shown anywhere....

vue-docgen-cli - Vue Styleguidist

Isolated Vue component development environment with a living style guide.

vue-docgen-cli | Yarn - Package Manager

vue -docgen-cli. Generate documentation markdown files from VueJs components using the vue-docgen-api. Install. Install the module directly from npm:

vue-docgen-api - npm

vue -docgen-api. TypeScript icon, indicating that this package has built-in type declarations · Readme · Code Beta · 11 Dependencies · 84 Dependents ......

What's New in vue-styleguidist 3.0 - DigitalOcean

If not, vue-styleguidist was missing documentation for the props in the mixin. Starting from version 3.0, this tagging is not necessary anymore.