Skip to content

Commit c6a87f3

Browse files
microcipcipmicrocipcip
committed
docs: Add demo and source links to the storybook documentation
1 parent 202a96c commit c6a87f3

File tree

13 files changed

+99
-45
lines changed

13 files changed

+99
-45
lines changed

‎src/components/getQuery/stories/getQuery.story.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
import { storiesOf } from '@storybook/vue'
2+
import path from 'path'
23
import StoryTitle from '../../../helpers/StoryTitle.vue'
34
import GetQueryDemo from './GetQueryDemo.vue'
45

5-
const storiesPath = __dirname
6-
const notes = require('./getQuery.md').default
6+
const functionName = 'getQuery'
7+
const functionPath = path.resolve(__dirname, '..')
8+
const notes = require(`./${functionName}.md`).default
79

810
const basicDemo = () => ({
911
components: { StoryTitle, demo: GetQueryDemo },
1012
template: `
1113
<div class="container">
12-
<story-title stories-path="${storiesPath}" file-name="GetQueryDemo.vue">
14+
<story-title stories-path="${functionPath}" file-name="GetQueryDemo.vue">
1315
<template v-slot:title></template>
1416
<template v-slot:intro></template>
1517
</story-title>

‎src/components/useClickAway/stories/useClickAway.story.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
import { storiesOf } from '@storybook/vue'
2+
import path from 'path'
23
import StoryTitle from '../../../helpers/StoryTitle.vue'
34
import UseClickAwayDemo from './UseClickAwayDemo.vue'
45

5-
const storiesPath = __dirname
6-
const notes = require('./useClickAway.md').default
6+
const functionName = 'useClickAway'
7+
const functionPath = path.resolve(__dirname, '..')
8+
const notes = require(`./${functionName}.md`).default
79

810
const basicDemo = () => ({
911
components: { StoryTitle, demo: UseClickAwayDemo },
1012
template: `
1113
<div class="container">
12-
<story-title stories-path="${storiesPath}" file-name="UseClickAwayDemo.vue">
14+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseClickAwayDemo.vue">
1315
<template v-slot:title></template>
1416
<template v-slot:intro>
1517
<p>

‎src/components/useHover/stories/useHover.story.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
import { storiesOf } from '@storybook/vue'
2+
import path from 'path'
23
import StoryTitle from '../../../helpers/StoryTitle.vue'
34
import UseHoverDemo from './UseHoverDemo.vue'
45

5-
const storiesPath = __dirname
6-
const notes = require('./useHover.md').default
6+
const functionName = 'useHover'
7+
const functionPath = path.resolve(__dirname, '..')
8+
const notes = require(`./${functionName}.md`).default
79

810
const basicDemo = () => ({
911
components: { StoryTitle, demo: UseHoverDemo },
1012
template: `
1113
<div class="container">
12-
<story-title stories-path="${storiesPath}" file-name="UseHoverDemo.vue">
14+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseHoverDemo.vue">
1315
<template v-slot:title></template>
1416
<template v-slot:intro>
1517
Try to move the mouse hover the box below to see the emoji change of expression.

‎src/components/useMedia/stories/useMedia.story.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
import { storiesOf } from '@storybook/vue'
2+
import path from 'path'
23
import StoryTitle from '../../../helpers/StoryTitle.vue'
34
import UseMediaDemo from './UseMediaDemo.vue'
45
import UseMediaAdvancedDemo from './UseMediaAdvancedDemo.vue'
56

6-
const storiesPath = __dirname
7-
const notes = require('./useMedia.md').default
7+
const functionName = 'useMedia'
8+
const functionPath = path.resolve(__dirname, '..')
9+
const notes = require(`./${functionName}.md`).default
810

911
const basicDemo = () => ({
1012
components: { StoryTitle, demo: UseMediaDemo },
1113
template: `
1214
<div class="container">
13-
<story-title stories-path="${storiesPath}" file-name="UseMediaDemo.vue">
15+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseMediaDemo.vue">
1416
<template v-slot:title></template>
1517
<template v-slot:intro>
1618
<p>
@@ -26,7 +28,7 @@ const advancedDemo = () => ({
2628
components: { StoryTitle, demo: UseMediaAdvancedDemo },
2729
template: `
2830
<div class="container">
29-
<story-title stories-path="${storiesPath}" file-name="UseMediaAdvancedDemo.vue">
31+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseMediaAdvancedDemo.vue">
3032
<template v-slot:title>Advanced demo</template>
3133
<template v-slot:intro>
3234
<p>

‎src/components/useMouse/stories/useMouse.story.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
import { storiesOf } from '@storybook/vue'
2+
import path from 'path'
23
import StoryTitle from '../../../helpers/StoryTitle.vue'
34
import UseMouseDemo from './UseMouseDemo.vue'
45
import UseMouseAdvancedDemo from './UseMouseAdvancedDemo.vue'
56

6-
const storiesPath = __dirname
7-
const notes = require('./useMouse.md').default
7+
const functionName = 'useMouse'
8+
const functionPath = path.resolve(__dirname, '..')
9+
const notes = require(`./${functionName}.md`).default
810

911
const basicDemo = () => ({
1012
components: { StoryTitle, demo: UseMouseDemo },
1113
template: `
1214
<div class="container">
13-
<story-title stories-path="${storiesPath}" file-name="UseMouseDemo.vue">
15+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseMouseDemo.vue">
1416
<template v-slot:title></template>
1517
<template v-slot:intro></template>
1618
</story-title>
@@ -22,7 +24,7 @@ const advancedDemo = () => ({
2224
components: { StoryTitle, demo: UseMouseAdvancedDemo },
2325
template: `
2426
<div class="container">
25-
<story-title stories-path="${storiesPath}" file-name="UseMouseAdvancedDemo.vue">
27+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseMouseAdvancedDemo.vue">
2628
<template v-slot:title>Advanced demo</template>
2729
<template v-slot:intro>
2830
<p>

‎src/components/useMouseElement/stories/useMouseElement.story.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
import { storiesOf } from '@storybook/vue'
2+
import path from 'path'
23
import StoryTitle from '../../../helpers/StoryTitle.vue'
34
import UseMouseElementDemo from './UseMouseElementDemo.vue'
45

5-
const storiesPath = __dirname
6-
const notes = require('./useMouseElement.md').default
6+
const functionName = 'useMouseElement'
7+
const functionPath = path.resolve(__dirname, '..')
8+
const notes = require(`./${functionName}.md`).default
79

810
const basicDemo = () => ({
911
components: { StoryTitle, demo: UseMouseElementDemo },
1012
template: `
1113
<div class="container">
12-
<story-title stories-path="${storiesPath}" file-name="UseMouseElementDemo.vue">
14+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseMouseElementDemo.vue">
1315
<template v-slot:title></template>
1416
<template v-slot:intro>
1517
<p>

‎src/components/useRafFn/stories/useRafFn.story.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
import { storiesOf } from '@storybook/vue'
2+
import path from 'path'
23
import StoryTitle from '../../../helpers/StoryTitle.vue'
34
import UseRafFnDemo from './UseRafFnDemo.vue'
45

5-
const storiesPath = __dirname
6-
const notes = require('./useRafFn.md').default
6+
const functionName = 'useRafFn'
7+
const functionPath = path.resolve(__dirname, '..')
8+
const notes = require(`./${functionName}.md`).default
79

810
const basicDemo = () => ({
911
components: { StoryTitle, demo: UseRafFnDemo },
1012
template: `
1113
<div class="container">
12-
<story-title stories-path="${storiesPath}" file-name="UseRafFnDemo.vue">
14+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseRafFnDemo.vue">
1315
<template v-slot:title></template>
1416
<template v-slot:intro></template>
1517
</story-title>

‎src/components/useSampleComponent/stories/useSampleComponent.storySample.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
import { storiesOf } from '@storybook/vue'
2+
import path from 'path'
23
import StoryTitle from '../../../helpers/StoryTitle.vue'
34
import UseSampleComponentDemo from './UseSampleComponentDemo.vue'
45

5-
const storiesPath = __dirname
6-
const notes = require('./useSampleComponent.md').default
6+
const functionName = 'useSampleComponent'
7+
const functionPath = path.resolve(__dirname, '..')
8+
const notes = require(`./${functionName}.md`).default
79

810
const basicDemo = () => ({
911
components: { StoryTitle, demo: UseSampleComponentDemo },
1012
template: `
1113
<div class="container">
12-
<story-title stories-path="${storiesPath}" file-name="UseSampleComponentDemo.vue">
14+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseSampleComponentDemo.vue">
1315
<template v-slot:title></template>
1416
<template v-slot:intro></template>
1517
</story-title>

‎src/components/useSampleComponent/useSampleComponent.spec.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// import { mount } from '../../helpers/test'
2+
// import { useSampleComponent } from '../../vue-use-kit'
3+
14
describe('useSampleComponent', () => {
25
it('should do something', () => {
36
// Add test here

‎src/components/useTimeout/stories/useTimeout.story.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
import { storiesOf } from '@storybook/vue'
2+
import path from 'path'
23
import StoryTitle from '../../../helpers/StoryTitle.vue'
34
import UseTimeoutDemo from './UseTimeoutDemo.vue'
45

5-
const storiesPath = __dirname
6-
const notes = require('./useTimeout.md').default
6+
const functionName = 'useTimeout'
7+
const functionPath = path.resolve(__dirname, '..')
8+
const notes = require(`./${functionName}.md`).default
79

810
const basicDemo = () => ({
911
components: { StoryTitle, demo: UseTimeoutDemo },
1012
template: `
1113
<div class="container">
12-
<story-title stories-path="${storiesPath}" file-name="UseTimeoutDemo.vue">
14+
<story-title function-path="${functionPath}" source-name="${functionName}" demo-name="UseTimeoutDemo.vue">
1315
<template v-slot:title></template>
1416
<template v-slot:intro></template>
1517
</story-title>

0 commit comments

Comments
 (0)