Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add storybook smoke test #4265

Merged
merged 3 commits into from
May 8, 2024
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
65 changes: 22 additions & 43 deletions frontend/src/components/VAudioTrack/meta/VAudioTrack.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
} from "@storybook/addon-docs"
import { computed } from "vue"
import { audioLayouts, audioSizes } from "~/constants/audio"
import { useProviderStore } from "~/stores/provider"

import VAudioTrack from "~/components/VAudioTrack/VAudioTrack.vue"

Expand All @@ -20,24 +21,26 @@ import wavWaveform from "./wav-waveform.json"
component={VAudioTrack}
argTypes={{
format: {
defaultValue: "mp3",
options: ["mp3", "ogg", "flac", "wav"],
control: "select",
},
layout: {
defaultValue: "full",
options: audioLayouts,
control: "select",
},
size: {
defaultValue: "m",
options: audioSizes,
control: "select",
},
audio: {
control: false,
},
}}
args={{
format: "mp3",
layout: "full",
size: "m",
}}
/>

export const commonAttrs = () => ({
Expand All @@ -47,6 +50,9 @@ export const commonAttrs = () => ({
category: "music",
thumbnail:
"https://upload.wikimedia.org/wikipedia/commons/thumb/4/47/Croce-Mozart-Detail.jpg/370px-Croce-Mozart-Detail.jpg",
frontendMediaType: "audio",
source: "wikimedia_audio",
sourceName: "Wikimedia",
})

export const formatExamples = {
Expand Down Expand Up @@ -80,10 +86,19 @@ export const formatExamples = {
},
}

export const providerStorePatch = {
providers: {
audio: [{ source_name: "wikimedia_audio", display_name: "Wikimedia" }],
},
sourceNames: { audio: ["Wikimedia"] },
}

export const Template = (args) => ({
template: `<VAudioTrack v-bind="args" :audio="audioObj"/>`,
components: { VAudioTrack },
setup() {
const providerStore = useProviderStore()
providerStore.$patch(providerStorePatch)
const audioObj = computed(() => ({
...commonAttrs(),
...formatExamples[args.format],
Expand All @@ -109,37 +124,8 @@ The component can be rendered in a multiple different layouts, by specifying a

### Full (default)

#### Size M (default)

<Canvas>
<Story
name="Full (medium)"
args={
{
// layout: 'full', (default)
// size: 'm', (default)
}
}
>
{Template.bind({})}
</Story>
</Canvas>

#### Size S (mobile)

<Canvas>
<Story
name="Full (small)"
args={{
// layout: 'full', (default)
size: "s",
}}
parameters={{
viewport: { defaultViewport: "sm" },
}}
>
{Template.bind({})}
</Story>
<Story name="Full">{Template.bind({})}</Story>
</Canvas>

### Row
Expand Down Expand Up @@ -191,7 +177,7 @@ The component can be rendered in a multiple different layouts, by specifying a

### Box

#### Sizes L and M (default)
#### Size L

There is no M size in box layout.

Expand All @@ -205,15 +191,6 @@ There is no M size in box layout.
>
{Template.bind({})}
</Story>
<Story
name="Box (medium)"
args={{
layout: "box",
size: "l",
}}
>
{Template.bind({})}
</Story>
</Canvas>

#### Size S (mobile)
Expand Down Expand Up @@ -277,6 +254,8 @@ export const Multiple = () => ({
`,
components: { VAudioTrack },
setup() {
const providerStore = useProviderStore()
providerStore.$patch(providerStorePatch)
const audioObj = (audio) => ({ ...commonAttrs(), ...audio })
return { formatExamples, audioObj }
},
Expand Down
10 changes: 6 additions & 4 deletions frontend/src/components/VAudioTrack/meta/VWaveform.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ import VWaveform from "~/components/VAudioTrack/VWaveform.vue"
action: "seeked",
},
}}
args={{
audioId: "audioId",
}}
/>

export const Template = (args) => ({
Expand All @@ -28,9 +31,9 @@ export const Template = (args) => ({

# Waveform

<Description of={Waveform} />
<Description of={VWaveform} />

<ArgsTable of={Waveform} />
<ArgsTable of={VWaveform} />

## Sampling

Expand Down Expand Up @@ -105,7 +108,7 @@ The waveform always takes the height and width of its container.
- **Height:** the bars will elongate proportionally to scale vertically
- **Width:** the number of samples will be adjusted to scale horizontally

Thus the `barWidth` and `barGap` will be maintained even in the case of
Thus, the `barWidth` and `barGap` will be maintained even in the case of
horizontal scaling.

## Usable area
Expand Down Expand Up @@ -160,7 +163,6 @@ will animate up to their actual height when the prop is unset.
name="Message"
args={{
message: "Hello, World!",
audioId: 123,
}}
>
{Template.bind({})}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ import VNotificationBanner from "~/components/VBanner/VNotificationBanner.vue"
action: "close",
},
}}
args={{
id: "banner",
text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec nec justo eget felis facilisis fermentum.",
}}
/>

export const Template = (args) => ({
Expand All @@ -36,7 +40,6 @@ export const Template = (args) => ({
<Story
name="Default"
args={{
text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec nec justo eget felis facilisis fermentum.",
nature: "success",
variant: "regular",
}}
Expand All @@ -49,7 +52,6 @@ export const Template = (args) => ({
<Story
name="Dark"
args={{
text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec nec justo eget felis facilisis fermentum.",
nature: "info",
variant: "dark",
}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ import {
Meta,
Story,
} from "@storybook/addon-docs"
import { useMediaStore } from "~/stores/media"
import { useProviderStore } from "~/stores/provider"

import VCollectionHeader from "~/components/VCollectionHeader/VCollectionHeader.vue"
import { useMediaStore } from "@/stores/media"

<Meta title="Components/VCollectionHeader" component={VCollectionHeader} />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import {

import VContentLink from "~/components/VContentLink/VContentLink.vue"

<Meta title="Components/VContentLink" components={VContentLink} argTypes={{}} />

export const contentLinkArgTypes = {
mediaType: { options: ["audio", "image"], control: { type: "radio" } },
searchTerm: { control: { type: "string" } },
Expand All @@ -18,6 +16,13 @@ export const contentLinkArgTypes = {
layout: { options: ["stacked", "horizontal"], control: { type: "radio" } },
}

<Meta
title="Components/VContentLink"
components={VContentLink}
argTypes={contentLinkArgTypes}
args={{ searchTerm: "cat" }}
/>

export const VContentLinkStory = (args) => ({
template: `<VContentLink v-bind="args" />`,
components: { VContentLink },
Expand Down Expand Up @@ -77,6 +82,7 @@ export const TwoVContentLinkStory = (args) => ({
mediaType: "image",
resultsCount: 5708,
isSelected: false,
searchTerm: "cat",
}}
argTypes={contentLinkArgTypes}
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,28 @@ import {
Meta,
Story,
} from "@storybook/addon-docs"
import { useFeatureFlagStore } from "~/stores/feature-flag"
import { useSearchStore } from "~/stores/search"

import VExternalSourceList from "~/components/VExternalSearch/VExternalSourceList.vue"

<Meta title="Components/VExternalSourceList" component={VExternalSourceList} />
<Meta
title="Components/VExternalSourceList"
component={VExternalSourceList}
args={{
searchTerm: "cat",
"search-term": "cat",
}}
/>

export const Template = (args) => ({
template: `<VExternalSourceList v-bind="args"/>`,
components: { VExternalSourceList },
setup() {
const featureFlagStore = useFeatureFlagStore()
featureFlagStore.toggleFeature("additional_search_types", "on")
const searchStore = useSearchStore()
searchStore.setSearchType(args.searchType)
return { args }
},
})
Expand All @@ -27,55 +40,23 @@ export const Template = (args) => ({
## Images

<Canvas>
<Story
name="Images"
args={{
type: "image",
query: { q: "cat" },
}}
>
{Template.bind({})}
</Story>
<Story name="Images">{Template.bind({})}</Story>
</Canvas>

## Audio

<Canvas>
<Story
name="Audio"
args={{
type: "audio",
query: { q: "cat" },
}}
>
{Template.bind({})}
</Story>
<Story name="Audio">{Template.bind({})}</Story>
</Canvas>

## Video

<Canvas>
<Story
name="Video"
args={{
type: "video",
query: { q: "cat" },
}}
>
{Template.bind({})}
</Story>
<Story name="Video">{Template.bind({})}</Story>
</Canvas>

## 3D models

<Canvas>
<Story
name="3D models"
args={{
type: "model-3d",
query: { q: "cat" },
}}
>
{Template.bind({})}
</Story>
<Story name="3D models">{Template.bind({})}</Story>
</Canvas>
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ import { ALL_LICENSES } from "~/constants/license"
components={VLicenseExplanation}
argTypes={{
license: {
defaultValue: ALL_LICENSES[0],
options: ALL_LICENSES,
control: "select",
},
}}
args={{
license: ALL_LICENSES[0],
}}
/>

export const Template = (args) => ({
Expand Down
1 change: 0 additions & 1 deletion frontend/src/components/VHeader/VHeaderDesktop.vue
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
ref="searchBarRef"
v-model.trim="searchTerm"
class="me-4 flex-grow"
size="medium"
@submit="handleSearch"
>
<VSearchBarButton
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export default defineComponent({
},
size: {
type: String as PropType<keyof typeof FIELD_SIZES>,
required: true,
default: "medium",
},
placeholder: {
type: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ representing the search query.
export const vModelTemplate = (args) => ({
template: `
<div>
<VSearchBar v-model="text" size="standalone" v-on="args">
<VSearchBar v-model="text" v-on="args">
<span class="info text-xs font-semibold text-dark-charcoal-70 mx-4 whitespace-nowrap group-hover:text-dark-charcoal group-focus:text-dark-charcoal">
{{ text.length }} chars
</span>
Expand Down Expand Up @@ -93,7 +93,6 @@ easy `<input>` attributes like placeholders or HTML validations.
name="With placeholder"
args={{
placeholder: "Search query",
size: "large",
}}
>
{Template.bind({})}
Expand Down
Loading
Loading