:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import type { Meta, StoryObj } from '@storybook/react'
import { screen, within } from '@testing-library/dom'
import userEvent from '@testing-library/user-event'
import { useState } from 'react'
import { IconGraph } from '@posthog/icons'
import { LemonButton } from '@posthog/lemon-ui'
import { fn } from 'storybook/test'
import { MarkdownNotebook, MarkdownNotebookProps } from './MarkdownNotebook'
import { NotebookCollaborationConflict } from './types'
const textNotebook = `# Weekly activation review
Activation improved after the onboarding changes. **Signup completion** is up, *workspace setup* is steady, and <u>invite acceptance</u> needs a follow-up.
- Review activation trend
- Check enterprise onboarding recordings
- Add notes for the growth sync
> Key takeaways from the growth sync:
> - Activation is trending up
> - Onboarding drop-off needs a deeper look
\`\`\`
SELECT properties.$browser AS browser, count() AS pageview_count
FROM events
WHERE event = '$pageview' AND timestamp > now() - INTERVAL 7 DAY AND properties.$browser IS NOT NULL
GROUP BY browser
ORDER BY pageview_count DESC
\`\`\`
[Open dashboard](/dashboard/123)`
const queryNotebook = `# Product analytics
<Query query={{"kind":"InsightVizNode","source":{"kind":"TrendsQuery","series":[{"kind":"EventsNode","event":"$pageview","name":"Pageview"}]}}} />
The chart should stay editable as a notebook component while the surrounding text remains markdown-backed.`
const componentCatalogNotebook = `# Component catalog
<Query query={{"kind":"SavedInsightNode","shortId":"abc123"}} />
<PythonV2 title="Python" code="print('hello')" />
<SQLV2 title="SQL" code="select * from events" returnVariable="sql_df" />
<RecordingPlaylist title="Session recordings" />
<FeatureFlag id="new-onboarding" />
<Experiment id="checkout-copy-test" />
<Person id="user-123" />
<Group type="organization" key="posthog" />
<LLMTrace id="trace-123" />`
const embedsNotebook = `# Embeds

<Embed src="${window.location.origin}/mock-page.html" title="PostHog demo page" />
<Latex content="E=mc^2" />`
const mermaidNotebook = `# Release flow
A \`\`\`mermaid\`\`\` fence renders as a diagram in view mode while the source stays editable.
\`\`\`mermaid
flowchart LR
A[Start] --> B{Tests pass?}
B -->|Yes| C[Ship it]
B -->|No| D[Fix it]
D --> A
\`\`\``
const wideMermaidNotebook = `# Wide diagram
A diagram wider than the notebook column keeps its natural size and scrolls horizontally instead of shrinking.
\`\`\`mermaid
flowchart LR
A[Signup form submitted] --> B[Validate email domain] --> C[Create organization] --> D[Provision default project] --> E[Send verification email] --> F[Track activation event] --> G[Redirect to onboarding] --> H[Show product tour]
\`\`\``
const invalidMermaidNotebook = `# Broken diagram
Invalid mermaid falls back to the plain source instead of crashing.
\`\`\`mermaid
flowchart LR
A --> B -->
this is not valid mermaid ]]]
\`\`\``
const malformedNotebook = `# Broken input
<Query query={{"kind":`
const invalidPropsNotebook = `# Invalid props
<Query />`
type StoryArgs = MarkdownNotebookProps
const meta: Meta<StoryArgs> = {
title: 'Components/Markdown notebook',
component: MarkdownNotebook,
tags: ['autodocs'],
args: {
showDebug: true,
onInteractionStateChange: () => {},
onCaretChange: fn(),
},
render: (props) => <ControlledNotebook {...props} />,
}
export default meta
type Story = StoryObj<StoryArgs>
function ControlledNotebook(props: MarkdownNotebookProps): JSX.Element {
const [value, setValue] = useState(props.value)
return <MarkdownNotebook {...props} value={value} onChange={setValue} onAskAI={props.onAskAI ?? (() => {})} />
}
function CollaborationNotebook(props: MarkdownNotebookProps): JSX.Element {
const [value, setValue] = useState(props.value)
const [remoteValue, setRemoteValue] = useState<string | undefined>(undefined)
const [conflicts, setConflicts] = useState<NotebookCollaborationConflict[]>([])
return (
<div className="deprecated-space-y-3">
<div className="flex gap-2">
<LemonButton
size="small"
onClick={() =>
setRemoteValue(`${textNotebook}
Remote editor added a new follow-up below the checklist.`)
}
>
Apply remote text edit
</LemonButton>
<LemonButton
size="small"
onClick={() =>
setRemoteValue(`# Weekly activation review
Remote editor rewrote the opening paragraph.
${queryNotebook}`)
}
>
Apply conflicting edit
</LemonButton>
</div>
<MarkdownNotebook
{...props}
value={value}
remoteValue={remoteValue}
onChange={setValue}
onAskAI={props.onAskAI ?? (() => {})}
onConflict={setConflicts}
/>
{conflicts.length ? (
<div className="border rounded p-2">
{conflicts.map((conflict) => (
<div key={conflict.nodeId}>{conflict.reason}</div>
))}
</div>
) : null}
</div>
)
}
export const EmptyNotebook: Story = {
args: {
value: '',
},
}
export const TextOnlyNotebook: Story = {
args: {
value: textNotebook,
},
}
export const CanvasHeader: Story = {
args: {
value: textNotebook,
canvasHeader: (
<div className="mb-2 w-full rounded border border-primary bg-surface-secondary p-2">
A panel in the canvas header takes the same left and right edges as the blocks below it.
</div>
),
},
}
export const HeadingsAndInlineFormatting: Story = {
args: {
value: `# Heading 1
## Heading 2
### Heading 3
Normal text with **bold**, *italic*, <u>underline</u>, ~~strikethrough~~, \`code\`, and [a link](https://posthog.com).
---
Text below a divider.`,
},
}
export const ListsAndLinks: Story = {
args: {
value: `1. First priority
2. Second priority
3. Third priority
- Product analytics
- Session replay
- Feature flags
- [x] Ship the onboarding experiment
- [ ] Review session recordings
- [ ] Share findings with the team
[Open PostHog](https://posthog.com)`,
},
}
export const TablesInProse: Story = {
args: {
value: `## Weekly activation review
Signup completion improved after the onboarding changes.
| Step | Completion | Change |
| --- | ---: | ---: |
| Signup form | 82% | +4% |
| Workspace setup | 61% | +1% |
Both tables above and below belong to this passage, so they share its card.
| Segment | Invite acceptance |
| --- | ---: |
| Self-serve | 44% |
| Enterprise | 71% |
The table below was added as a node of its own, so it keeps a card of its own.
| Owner | Follow-up |
| --- | --- |
| Growth | Retry the invite email |
| Onboarding | Shorten the setup step |`,
},
}
export const QueryBlock: Story = {
args: {
value: queryNotebook,
},
}
export const ComponentCatalog: Story = {
args: {
value: componentCatalogNotebook,
},
}
export const Embeds: Story = {
args: {
value: embedsNotebook,
},
}
export const MermaidDiagram: Story = {
args: {
value: mermaidNotebook,
mode: 'view',
},
// Mermaid renders asynchronously (lazy chunk + async render); wait for the finished SVG
// so the snapshot isn't captured mid-render.
parameters: {
testOptions: { waitForSelector: '[data-attr="mermaid-rendered"]' },
},
}
export const MermaidDiagramEditor: Story = {
args: {
value: mermaidNotebook,
mode: 'edit',
},
parameters: {
testOptions: { waitForSelector: '[data-attr="notebook-mermaid-editor"]' },
},
play: async ({ canvasElement }) => {
const canvas = within(canvasElement)
const editButton = await canvas.findByLabelText('Edit diagram')
editButton.focus()
await userEvent.keyboard('{Enter}')
await screen.findByLabelText('Mermaid definition')
},
}
export const MermaidDiagramWide: Story = {
args: {
value: wideMermaidNotebook,
mode: 'view',
},
// Mermaid renders asynchronously (lazy chunk + async render); wait for the finished SVG
// so the snapshot isn't captured mid-render.
parameters: {
testOptions: { waitForSelector: '[data-attr="mermaid-rendered"]' },
},
}
export const MermaidDiagramFallback: Story = {
args: {
value: invalidMermaidNotebook,
mode: 'view',
},
// Invalid mermaid resolves asynchronously to the error fallback; wait for it before snapshotting.
parameters: {
testOptions: { waitForSelector: '[data-attr="mermaid-error"]' },
},
}
export const MalformedMarkdownRecovery: Story = {
args: {
value: malformedNotebook,
},
}
export const InvalidComponentProps: Story = {
args: {
value: invalidPropsNotebook,
},
}
export const ViewMode: Story = {
args: {
value: componentCatalogNotebook,
mode: 'view',
},
}
export const EditMode: Story = {
args: {
value: componentCatalogNotebook,
mode: 'edit',
},
}
export const SelectionToolbarState: Story = {
args: {
value: `# Selection toolbar
Select part of this paragraph to format it from the inline toolbar.`,
},
}
export const BtwSelection: Story = {
...SelectionToolbarState,
args: { ...SelectionToolbarState.args, onBtw: fn() },
}
export const BtwSlashMenu: Story = {
args: {
value: '# BTW\n\n ',
initialInsertMenu: { nodeIndex: 1, query: '' },
onBtw: fn(),
},
}
export const SlashMenuAndInsertion: Story = {
args: {
value: '',
initialInsertMenu: { nodeIndex: 0, query: '' },
// Extra commands are injected by the caller (the scenes layer wires up "Saved insight"); a stub
// command keeps that row present in the menu snapshot without mounting any real modal.
extraInsertCommands: () => [
{
key: 'query-saved-insight',
label: 'Saved insight',
category: 'Insight',
icon: <IconGraph />,
run: () => {},
},
],
},
}
export const AskAIWithoutConsent: Story = {
args: {
value: '',
initialInsertMenu: { nodeIndex: 0, query: '' },
onAskAI: fn(),
askAIDisabledReason: 'Approve AI data processing in organization settings to use Ask AI.',
},
}
export const MockedCollaboration: Story = {
args: {
value: textNotebook,
},
render: (props) => <CollaborationNotebook {...props} />,
}