Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion addons/docs/src/frameworks/svelte/config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { extractArgTypes } from './extractArgTypes';
import { extractComponentDescription } from '../../lib/docgen';
import { extractComponentDescription } from './extractComponentDescription';
import { prepareForInline } from './prepareForInline';

export const parameters = {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { extractComponentDescription } from './extractComponentDescription';

describe('extractComponentDescription', () => {
test('Extract from docgen', () => {
expect(extractComponentDescription({ __docgen: { description: 'a description' } })).toBe(
'a description'
);
});
test('Null Component', () => {
expect(extractComponentDescription(null)).toBeFalsy();
});
test('Missing docgen', () => {
expect(extractComponentDescription({})).toBeFalsy();
});
});
10 changes: 10 additions & 0 deletions addons/docs/src/frameworks/svelte/extractComponentDescription.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import { Component } from '../../blocks/types';

export function extractComponentDescription(component?: Component): string {
if (!component) {
return null;
}

const { __docgen = {} } = component;
return __docgen.description;
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<script>
/**
* Control Showcase
* @component
*/
import Button from '../../components/Button.svelte';

/**
Expand Down