docs: interpretations storybook examples

Author: cooper-joe

.storybook/preview.js

@@ -1,10 +1,11 @@
-import { CssReset } from '@dhis2/ui'
+import { CssReset, CssVariables } from '@dhis2/ui'
 import React from 'react'
 
 export const decorators = [
     (Story) => (
         <div>
             <CssReset />
+            <CssVariables spacers colors layers elevations theme />
             <Story />
             <style jsx>{`
                 :global(html) {

src/__demo__/InterpretationModal.stories.js

@@ -0,0 +1,333 @@
+import { CustomDataProvider } from '@dhis2/app-runtime'
+import i18n from '@dhis2/d2-i18n'
+import { colors, spacers, DropdownButton } from '@dhis2/ui'
+import PropTypes from 'prop-types'
+import React from 'react'
+import { InterpretationModal } from '../components/Interpretations/InterpretationModal/InterpretationModal.js'
+import { InterpretationsProvider } from '../components/Interpretations/InterpretationsProvider/InterpretationsProvider.js'
+
+export default {
+    title: 'InterpretationModal',
+}
+
+const currentUser = {
+    id: 'user001',
+    name: 'Tom Wakiki',
+    authorities: [],
+    settings: {
+        keyAnalysisDisplayProperty: 'name',
+    },
+}
+
+const makeInterpretation = (overrides) => ({
+    id: 'interp-1',
+    text: 'Interpretation text',
+    created: '2026-04-10T14:22:00.000',
+    likes: 0,
+    createdBy: {
+        id: 'user002',
+        displayName: 'Amina Diallo',
+    },
+    comments: [],
+    likedBy: [],
+    access: { write: true, manage: false },
+    ...overrides,
+})
+
+const PlaceholderVisualization = () => (
+    <div
+        style={{
+            width: '100%',
+            height: '100%',
+            minHeight: 300,
+            display: 'flex',
+            alignItems: 'center',
+            justifyContent: 'center',
+            backgroundColor: colors.grey100,
+            border: `1px dashed ${colors.grey400}`,
+            borderRadius: 4,
+            color: colors.grey700,
+            fontSize: 14,
+            padding: spacers.dp16,
+        }}
+    >
+        Visualization placeholder
+    </div>
+)
+
+const ModalDownloadDropdown = () => (
+    <div style={{ marginTop: spacers.dp12, marginBottom: spacers.dp16 }}>
+        <DropdownButton
+            component={<div />}
+            disabled
+            open={false}
+            secondary
+            small
+        >
+            {i18n.t('Download data from this date')}
+        </DropdownButton>
+    </div>
+)
+
+const ModalStory = ({ interpretation, interpretationsResolver, children }) => (
+    <CustomDataProvider
+        data={{
+            interpretations:
+                interpretationsResolver ??
+                ((_type, query) => {
+                    if (query.id) {
+                        return interpretation
+                    }
+                    return { interpretations: [interpretation] }
+                }),
+        }}
+    >
+        <InterpretationsProvider currentUser={currentUser}>
+            {children}
+        </InterpretationsProvider>
+    </CustomDataProvider>
+)
+
+ModalStory.propTypes = {
+    children: PropTypes.node,
+    interpretation: PropTypes.object,
+    interpretationsResolver: PropTypes.func,
+}
+
+export const NoComments = () => {
+    const interpretation = makeInterpretation({
+        text: 'The ANC coverage rate has improved steadily across all districts this quarter, with the Eastern region showing the most significant gains.',
+        likes: 2,
+        likedBy: [{ id: 'user001' }, { id: 'user003' }],
+    })
+
+    return (
+        <ModalStory interpretation={interpretation}>
+            <InterpretationModal
+                interpretationId="interp-1"
+                isVisualizationLoading={false}
+                visualization={{
+                    id: 'viz-1',
+                    displayName: 'ANC Coverage by District - Q1 2026',
+                }}
+                pluginComponent={PlaceholderVisualization}
+                downloadMenuComponent={ModalDownloadDropdown}
+                onClose={Function.prototype}
+                onResponsesReceived={Function.prototype}
+            />
+        </ModalStory>
+    )
+}
+
+NoComments.story = {
+    name: 'No comments',
+}
+
+export const WithAFewComments = () => {
+    const interpretation = makeInterpretation({
+        text: 'Immunization coverage for Penta 3 dropped below 80% in three districts last month. This needs urgent attention before the next reporting cycle.',
+        likes: 5,
+        likedBy: [
+            { id: 'user001' },
+            { id: 'user003' },
+            { id: 'user004' },
+            { id: 'user005' },
+            { id: 'user006' },
+        ],
+        comments: [
+            {
+                id: 'c1',
+                text: 'I checked the district-level data and it looks like the drop is concentrated in two facilities that had staff turnover last month.',
+                created: '2026-04-11T09:15:00.000',
+                createdBy: {
+                    id: 'user003',
+                    displayName: 'James Okonkwo',
+                },
+            },
+            {
+                id: 'c2',
+                text: 'We should flag this for the regional review meeting next week.',
+                created: '2026-04-11T11:42:00.000',
+                createdBy: {
+                    id: 'user004',
+                    displayName: 'Dr. Fatou Mensah',
+                },
+            },
+            {
+                id: 'c3',
+                text: 'Agreed. I will prepare a summary of the affected facilities and share it before the meeting.',
+                created: '2026-04-12T08:05:00.000',
+                createdBy: {
+                    id: 'user001',
+                    displayName: 'Tom Wakiki',
+                },
+            },
+        ],
+    })
+
+    return (
+        <ModalStory interpretation={interpretation}>
+            <InterpretationModal
+                interpretationId="interp-1"
+                isVisualizationLoading={false}
+                visualization={{
+                    id: 'viz-2',
+                    displayName:
+                        'Penta 3 Immunization Coverage by District Sorted by Participation Rates and Coverage Beyond District Funding Levels - March 2026',
+                }}
+                pluginComponent={PlaceholderVisualization}
+                // downloadMenuComponent={ModalDownloadDropdown}
+                onClose={Function.prototype}
+                onResponsesReceived={Function.prototype}
+            />
+        </ModalStory>
+    )
+}
+
+WithAFewComments.story = {
+    name: 'With a few comments',
+}
+
+export const WithManyComments = () => {
+    const interpretation = makeInterpretation({
+        text: 'Disease surveillance data shows an unusual cluster of acute watery diarrhoea cases in the Ashanti region. The pattern warrants investigation by the rapid response team.',
+        likes: 10,
+        likedBy: [
+            { id: 'user001' },
+            { id: 'user002' },
+            { id: 'user003' },
+            { id: 'user004' },
+            { id: 'user005' },
+            { id: 'user006' },
+            { id: 'user007' },
+            { id: 'user008' },
+            { id: 'user009' },
+            { id: 'user010' },
+        ],
+        comments: [
+            {
+                id: 'c1',
+                text: 'I noticed this trend last week. The cluster seems to be centred around the Kumasi metropolitan area.',
+                created: '2026-04-10T15:30:00.000',
+                createdBy: {
+                    id: 'user003',
+                    displayName: 'James Okonkwo',
+                },
+            },
+            {
+                id: 'c2',
+                text: 'Could this be linked to the water supply disruption reported two weeks ago? The timing fits.',
+                created: '2026-04-10T16:12:00.000',
+                createdBy: {
+                    id: 'user004',
+                    displayName: 'Dr. Fatou Mensah',
+                },
+            },
+            {
+                id: 'c3',
+                text: 'Good point. I have pulled the WASH indicators for those communities and there is a clear correlation with facilities reporting low water quality scores.',
+                created: '2026-04-11T08:45:00.000',
+                createdBy: {
+                    id: 'user005',
+                    displayName: 'Kwame Asante',
+                },
+            },
+            {
+                id: 'c4',
+                text: 'The rapid response team has been notified. They are planning field visits for Thursday and Friday this week.',
+                created: '2026-04-11T10:20:00.000',
+                createdBy: {
+                    id: 'user006',
+                    displayName: 'Grace Nkrumah',
+                },
+            },
+            {
+                id: 'c5',
+                text: 'We should also check neighbouring districts for any spillover. Brong-Ahafo and Eastern regions share water sources with some of the affected communities.',
+                created: '2026-04-11T14:00:00.000',
+                createdBy: {
+                    id: 'user001',
+                    displayName: 'Tom Wakiki',
+                },
+            },
+            {
+                id: 'c6',
+                text: 'Preliminary lab results from Komfo Anokye confirm Vibrio cholerae in 3 of the 8 samples. This needs to be escalated immediately.',
+                created: '2026-04-12T07:30:00.000',
+                createdBy: {
+                    id: 'user004',
+                    displayName: 'Dr. Fatou Mensah',
+                },
+            },
+            {
+                id: 'c7',
+                text: 'I have updated the weekly epidemiological bulletin to include this cluster. The national surveillance team has been copied.',
+                created: '2026-04-12T09:55:00.000',
+                createdBy: {
+                    id: 'user007',
+                    displayName: 'Samuel Owusu',
+                },
+            },
+            {
+                id: 'c8',
+                text: 'Stock levels of ORS and IV fluids at the affected facilities look adequate for now, but we should monitor daily given the trajectory.',
+                created: '2026-04-12T13:10:00.000',
+                createdBy: {
+                    id: 'user005',
+                    displayName: 'Kwame Asante',
+                },
+            },
+        ],
+    })
+
+    return (
+        <ModalStory interpretation={interpretation}>
+            <InterpretationModal
+                interpretationId="interp-1"
+                isVisualizationLoading={false}
+                visualization={{
+                    id: 'viz-3',
+                    displayName:
+                        'Acute Watery Diarrhoea Cases - Ashanti Region Weekly Surveillance',
+                }}
+                pluginComponent={PlaceholderVisualization}
+                downloadMenuComponent={ModalDownloadDropdown}
+                onClose={Function.prototype}
+                onResponsesReceived={Function.prototype}
+            />
+        </ModalStory>
+    )
+}
+
+WithManyComments.story = {
+    name: 'With many comments',
+}
+
+export const Error = () => (
+    <ModalStory
+        interpretationsResolver={() =>
+            Promise.reject(
+                new Error(
+                    'Network request failed while loading the interpretation'
+                )
+            )
+        }
+    >
+        <InterpretationModal
+            interpretationId="interp-1"
+            isVisualizationLoading={false}
+            visualization={{
+                id: 'viz-error',
+                displayName: 'Errored visualization',
+            }}
+            pluginComponent={PlaceholderVisualization}
+            downloadMenuComponent={ModalDownloadDropdown}
+            onClose={Function.prototype}
+            onResponsesReceived={Function.prototype}
+        />
+    </ModalStory>
+)
+
+Error.story = {
+    name: 'Error',
+}