arielsalminen / vue-design-system

An open source tool for building UI Design Systems with Vue.js
https://vueds.com
MIT License
2.17k stars 225 forks source link

Component descriptions no longer get rendered when there are import statements #146

Open sdellis opened 5 years ago

sdellis commented 5 years ago

In this example, my Gallery component uses Vuex to manage state. The description used to get rendered in my docs, but this is no longer the case since the 3.0 release.

<template>Gallery markup goes here...</template>
<script>
import store from "../store"
import { mapState, mapGetters } from "vuex"
/*
 * Gallery is a grid of selectable, draggable images with captions.
 */
export default {
  name: "Gallery",
  status: "ready",
  release: "1.0.0",
  type: "Pattern",
schjetne commented 4 years ago

It doesn't consistently happen, it seems.

This works:

<script>
import TextBlock from './TextBlock.vue'
import SvgIcon from './SvgIcon.vue'
import SmoothScroll from '../utils/SmoothScroll.js'

/**
 * The Day component for the [DatePicker](/#/Patterns/DatePicker) pattern
 */

export default {
  name: 'DatePickerDay',
  status: 'ready',
  release: '0.0.1',
  components: {
    SvgIcon,
    TextBlock,
  },

This doesn't:

<script>
import { format } from 'date-fns'
import { enUS as en, nb as no, sv, da, de, nl } from 'date-fns/locale'
const locales = { en, no, sv, da, de, nl }

/**
 * For displaying non-interactive lists of dates. Useful for listing out event dates for a specific event.
 */

export default {
  name: 'DatesList',
  status: 'ready',
  release: '0.1.8',
  tags: ['dates', 'events', 'list', 'element'],
  props: {
    /** Array of dates to display in list. Takes both Date objects and ISO date strings. */
    dates: {
      type: Array,
      required: true,
    },
    /** How to format the date. See https://date-fns.org/v2.0.1/docs/format */
    dateFormat: {
      type: String,
      default: 'do MMM y',
    },
    /** i18n language. Available languages: `en, no, sv, da, de, nl` */
    locale: {
      type: String,
      default: 'en',
    },
  },