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

Storybook: Destroy Cosmos when switching stories #129

Merged
merged 1 commit into from
Dec 27, 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
47 changes: 26 additions & 21 deletions src/stories/clusters.stories.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { Meta, StoryObj } from '@storybook/html'
import type { Meta } from '@storybook/html'
import { CosmosStoryProps } from '@/graph/stories/create-cosmos'
import { createStory, Story } from '@/graph/stories/create-story'
import { WithLabelsStory } from './clusters/with-labels'
import { WormStory } from './clusters/worm'
import { RadialStory } from './clusters/radial'
Expand All @@ -19,35 +20,39 @@ const meta: Meta<CosmosStoryProps> = {
},
}

type Story = StoryObj<CosmosStoryProps>;

const sourceCodeAddonParams = [
{ name: 'create-cosmos', code: createCosmosRaw },
{ name: 'generate-mesh-data', code: generateMeshDataRaw },
]

export const Worm = WormStory as Story
Worm.parameters = {
sourceCode: [
{ name: 'Story', code: wormStory },
...sourceCodeAddonParams,
],
export const Worm: Story = {
...createStory(WormStory),
parameters: {
sourceCode: [
{ name: 'Story', code: wormStory },
...sourceCodeAddonParams,
],
},
}

export const Radial = RadialStory as Story
Radial.parameters = {
sourceCode: [
{ name: 'Story', code: radialStory },
...sourceCodeAddonParams,
],
export const Radial: Story = {
...createStory(RadialStory),
parameters: {
sourceCode: [
{ name: 'Story', code: radialStory },
...sourceCodeAddonParams,
],
},
}

export const WithLabels = WithLabelsStory as Story
WithLabels.parameters = {
sourceCode: [
{ name: 'Story', code: withLabelsStory },
...sourceCodeAddonParams,
],
export const WithLabels: Story = {
...createStory(WithLabelsStory),
parameters: {
sourceCode: [
{ name: 'Story', code: withLabelsStory },
...sourceCodeAddonParams,
],
},
}

// eslint-disable-next-line import/no-default-export
Expand Down
8 changes: 4 additions & 4 deletions src/stories/clusters/radial.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@

import { Graph } from '@cosmograph/cosmos'
import { createCosmos } from '../create-cosmos'
import { generateMeshData } from '../generate-mesh-data'

export const RadialStory = (): HTMLDivElement => {
export const RadialStory = (): { graph: Graph; div: HTMLDivElement} => {
const {
pointPositions, pointColors, pointSizes,
links, linkColors, linkWidths,
pointClusters, clusterPositions, clusterStrength,
} = generateMeshData(100, 100, 100, 1.0)
const { div } = createCosmos({

return createCosmos({
pointPositions,
pointColors,
pointSizes,
Expand All @@ -19,6 +21,4 @@ export const RadialStory = (): HTMLDivElement => {
clusterPositions,
clusterStrength,
})

return div
}
5 changes: 3 additions & 2 deletions src/stories/clusters/with-labels.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@

import { Graph } from '@cosmograph/cosmos'
import { createClusterLabels } from '../create-cluster-labels'
import { createCosmos } from '../create-cosmos'
import { generateMeshData } from '../generate-mesh-data'

export const WithLabelsStory = (): HTMLDivElement => {
export const WithLabelsStory = (): {div: HTMLDivElement; graph: Graph } => {
const { pointPositions, pointColors, pointClusters } = generateMeshData(100, 100, 15, 1.0)
const { div, graph } = createCosmos({
pointPositions,
Expand All @@ -20,5 +21,5 @@ export const WithLabelsStory = (): HTMLDivElement => {
onSimulationTick: updateClusterLabels.bind(this, graph),
})

return div
return { div, graph }
}
8 changes: 4 additions & 4 deletions src/stories/clusters/worm.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@

import { Graph } from '@cosmograph/cosmos'
import { createCosmos } from '../create-cosmos'
import { generateMeshData } from '../generate-mesh-data'

export const WormStory = (): HTMLDivElement => {
export const WormStory = (): {graph: Graph; div: HTMLDivElement} => {
const { pointPositions, pointColors, links, linkColors, pointClusters } = generateMeshData(100, 100, 1000, 1.0)
const { div } = createCosmos({

return createCosmos({
simulationGravity: 0.5,
simulationRepulsion: 1,
simulationLinkSpring: 1,
Expand All @@ -14,6 +16,4 @@ export const WormStory = (): HTMLDivElement => {
links,
linkColors,
})

return div
}
2 changes: 0 additions & 2 deletions src/stories/create-cosmos.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,8 @@ export type CosmosStoryProps = GraphConfigInterface & {

export const createCosmos = (props: CosmosStoryProps): { div: HTMLDivElement; graph: Graph} => {
const div = document.createElement('div')
// const canvas = document.createElement('canvas')
div.style.height = '100vh'
div.style.width = '100%'
// div.appendChild(canvas)

const config: GraphConfigInterface = {
backgroundColor: '#212C42',
Expand Down
21 changes: 21 additions & 0 deletions src/stories/create-story.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { Graph } from '@cosmograph/cosmos'
import type { StoryObj } from '@storybook/html'
import { CosmosStoryProps } from '@/graph/stories/create-cosmos'

export type Story = StoryObj<CosmosStoryProps & { graph: Graph }>;

export const createStory: (storyFunction: () => {
graph: Graph;
div: HTMLDivElement;
}) => Story = (storyFunction) => ({
async beforeEach (d): Promise<() => void> {
return (): void => {
d.args.graph?.destroy()
}
},
render: (args): HTMLDivElement => {
const story = storyFunction()
args.graph = story.graph
return story.div
},
})
33 changes: 18 additions & 15 deletions src/stories/experiments.stories.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { Meta, StoryObj } from '@storybook/html'
import type { Meta } from '@storybook/html'

import { createStory, Story } from '@/graph/stories/create-story'
import { CosmosStoryProps } from './create-cosmos'
import { MeshWithHolesStory } from './experiments/mesh-with-holes'
import { FullMeshStory } from './experiments/full-mesh'
Expand All @@ -14,26 +15,28 @@ const meta: Meta<CosmosStoryProps> = {
title: 'Examples/Experiments',
}

type Story = StoryObj<CosmosStoryProps>;

const sourceCodeAddonParams = [
{ name: 'create-cosmos', code: createCosmosRaw },
{ name: 'generate-mesh-data', code: generateMeshDataRaw },
]

export const FullMesh = FullMeshStory as Story
FullMesh.parameters = {
sourceCode: [
{ name: 'Story', code: fullMeshRaw },
...sourceCodeAddonParams,
],
export const FullMesh: Story = {
...createStory(FullMeshStory),
parameters: {
sourceCode: [
{ name: 'Story', code: fullMeshRaw },
...sourceCodeAddonParams,
],
},
}
export const MeshWithHoles = MeshWithHolesStory as Story
MeshWithHoles.parameters = {
sourceCode: [
{ name: 'Story', code: meshWithHolesRaw },
...sourceCodeAddonParams,
],
export const MeshWithHoles: Story = {
...createStory(MeshWithHolesStory),
parameters: {
sourceCode: [
{ name: 'Story', code: meshWithHolesRaw },
...sourceCodeAddonParams,
],
},
}

// eslint-disable-next-line import/no-default-export
Expand Down
8 changes: 4 additions & 4 deletions src/stories/experiments/full-mesh.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { Graph } from '@cosmograph/cosmos'
import { createCosmos } from '../create-cosmos'
import { generateMeshData } from '../generate-mesh-data'

export const FullMeshStory = (): HTMLDivElement => {
export const FullMeshStory = (): { graph: Graph; div: HTMLDivElement} => {
const { pointPositions, links, pointColors } = generateMeshData(40, 30, 15, 1.0)
const { div } = createCosmos({

return createCosmos({
pointPositions,
links,
pointColors,
})

return div
}
8 changes: 4 additions & 4 deletions src/stories/experiments/mesh-with-holes.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { Graph } from '@cosmograph/cosmos'
import { createCosmos } from '../create-cosmos'
import { generateMeshData } from '../generate-mesh-data'

export const MeshWithHolesStory = (): HTMLDivElement => {
export const MeshWithHolesStory = (): { graph: Graph; div: HTMLDivElement} => {
const { pointPositions, links, pointColors } = generateMeshData(40, 80, 15, 0.8)
const { div } = createCosmos({

return createCosmos({
pointPositions,
links,
pointColors,
})

return div
}
Loading