|
| 1 | +import React, { useCallback, useContext, useEffect, useRef } from 'react'; |
| 2 | +import { Steps } from 'antd'; |
| 3 | +import { LoadingOutlined } from '@ant-design/icons'; |
| 4 | +import { useImmer } from 'use-immer'; |
| 5 | +import { noop } from 'lodash'; |
| 6 | + |
| 7 | +const { Step } = Steps; |
| 8 | + |
| 9 | +// Nav state |
| 10 | + |
| 11 | +export enum NotebookNavStep { |
| 12 | + CsvImport, |
| 13 | + DataPreview, |
| 14 | + ColumnSelection, |
| 15 | + AnonymizationSummary, |
| 16 | + AnonymizedResults, |
| 17 | + CsvExport, |
| 18 | +} |
| 19 | + |
| 20 | +export type NotebookNavStepStatus = 'inactive' | 'active' | 'loading' | 'done' | 'failed'; |
| 21 | + |
| 22 | +type NotebookNavStepState = { |
| 23 | + htmlElement: HTMLElement | null; |
| 24 | + status: NotebookNavStepStatus; |
| 25 | +}; |
| 26 | + |
| 27 | +type NotebookNavState = { |
| 28 | + steps: NotebookNavStepState[]; |
| 29 | +}; |
| 30 | + |
| 31 | +const defaultNavState: NotebookNavState = { |
| 32 | + steps: Array(NotebookNavStep.CsvExport + 1) |
| 33 | + .fill(null) |
| 34 | + .map(() => ({ status: 'inactive', htmlElement: null })), |
| 35 | +}; |
| 36 | + |
| 37 | +const NotebookNavStateContext = React.createContext<NotebookNavState>(defaultNavState); |
| 38 | + |
| 39 | +function useNavState(): NotebookNavState { |
| 40 | + return useContext(NotebookNavStateContext); |
| 41 | +} |
| 42 | + |
| 43 | +// Nav functions |
| 44 | + |
| 45 | +type NotebookNavStepPatch = |
| 46 | + | { htmlElement: null; status?: never } |
| 47 | + | { htmlElement: HTMLElement; status: 'active' | 'loading' | 'done' | 'failed' } |
| 48 | + | { htmlElement?: never; status: NotebookNavStepStatus }; |
| 49 | + |
| 50 | +type NotebookNavFunctions = { |
| 51 | + updateStep(step: NotebookNavStep, patch: NotebookNavStepPatch): void; |
| 52 | +}; |
| 53 | + |
| 54 | +const NotebookNavFunctionsContext = React.createContext<NotebookNavFunctions>({ |
| 55 | + updateStep: noop, |
| 56 | +}); |
| 57 | + |
| 58 | +function useNavFunctions(): NotebookNavFunctions { |
| 59 | + return useContext(NotebookNavFunctionsContext); |
| 60 | +} |
| 61 | + |
| 62 | +// Context provider |
| 63 | + |
| 64 | +export const NotebookNavProvider: React.FunctionComponent = ({ children }) => { |
| 65 | + const [navState, updateNavState] = useImmer(defaultNavState); |
| 66 | + const navFunctions = useRef<NotebookNavFunctions>({ |
| 67 | + updateStep(step, patch) { |
| 68 | + updateNavState((draft) => { |
| 69 | + const { steps } = draft as NotebookNavState; |
| 70 | + if (patch.htmlElement === null) { |
| 71 | + steps[step] = { |
| 72 | + htmlElement: null, |
| 73 | + status: 'inactive', |
| 74 | + }; |
| 75 | + } else if (patch.htmlElement) { |
| 76 | + steps[step] = patch; |
| 77 | + } else if (steps[step].htmlElement) { |
| 78 | + steps[step].status = patch.status; |
| 79 | + } |
| 80 | + }); |
| 81 | + }, |
| 82 | + }); |
| 83 | + |
| 84 | + return ( |
| 85 | + <NotebookNavStateContext.Provider value={navState}> |
| 86 | + <NotebookNavFunctionsContext.Provider value={navFunctions.current}> |
| 87 | + {children} |
| 88 | + </NotebookNavFunctionsContext.Provider> |
| 89 | + </NotebookNavStateContext.Provider> |
| 90 | + ); |
| 91 | +}; |
| 92 | + |
| 93 | +// Context consumers |
| 94 | + |
| 95 | +export type NotebookNavAnchorProps = { |
| 96 | + step: NotebookNavStep; |
| 97 | + status?: NotebookNavStepStatus; |
| 98 | +}; |
| 99 | + |
| 100 | +export const NotebookNavAnchor: React.FunctionComponent<NotebookNavAnchorProps> = ({ step, status = 'active' }) => { |
| 101 | + const navFunctions = useNavFunctions(); |
| 102 | + |
| 103 | + const ref = useCallback( |
| 104 | + (htmlElement: HTMLElement | null) => { |
| 105 | + navFunctions.updateStep(step, { |
| 106 | + htmlElement, |
| 107 | + status, |
| 108 | + } as NotebookNavStepPatch); |
| 109 | + }, |
| 110 | + [step, status, navFunctions], |
| 111 | + ); |
| 112 | + |
| 113 | + return ( |
| 114 | + <div style={{ position: 'relative' }}> |
| 115 | + <div ref={ref} style={{ position: 'absolute', top: -60, left: 0 }}></div> |
| 116 | + </div> |
| 117 | + ); |
| 118 | +}; |
| 119 | + |
| 120 | +function mapStatus(status: NotebookNavStepStatus): 'error' | 'process' | 'finish' | 'wait' { |
| 121 | + switch (status) { |
| 122 | + case 'inactive': |
| 123 | + return 'wait'; |
| 124 | + case 'active': |
| 125 | + case 'loading': |
| 126 | + return 'process'; |
| 127 | + case 'done': |
| 128 | + return 'finish'; |
| 129 | + case 'failed': |
| 130 | + return 'error'; |
| 131 | + } |
| 132 | +} |
| 133 | + |
| 134 | +export const NotebookNav: React.FunctionComponent = () => { |
| 135 | + const { steps } = useNavState(); |
| 136 | + const status = (step: NotebookNavStep) => mapStatus(steps[step].status); |
| 137 | + |
| 138 | + return ( |
| 139 | + <Steps |
| 140 | + progressDot={(dot, { index }) => |
| 141 | + steps[index].status === 'loading' ? ( |
| 142 | + <span |
| 143 | + key="loading" |
| 144 | + className="ant-steps-icon-dot" |
| 145 | + style={{ |
| 146 | + backgroundColor: 'transparent', |
| 147 | + color: '#1890ff', |
| 148 | + left: -5, |
| 149 | + }} |
| 150 | + > |
| 151 | + <LoadingOutlined /> |
| 152 | + </span> |
| 153 | + ) : ( |
| 154 | + dot |
| 155 | + ) |
| 156 | + } |
| 157 | + direction="vertical" |
| 158 | + current={-1} |
| 159 | + onChange={(step) => { |
| 160 | + const { htmlElement } = steps[step]; |
| 161 | + if (htmlElement) { |
| 162 | + htmlElement.scrollIntoView({ |
| 163 | + behavior: 'smooth', |
| 164 | + block: 'start', |
| 165 | + }); |
| 166 | + } |
| 167 | + }} |
| 168 | + > |
| 169 | + <Step status={status(NotebookNavStep.CsvImport)} title="CSV Import" description="Load data from CSV" /> |
| 170 | + <Step status={status(NotebookNavStep.DataPreview)} title="Data Preview" description="Preview contents of file" /> |
| 171 | + <Step |
| 172 | + status={status(NotebookNavStep.ColumnSelection)} |
| 173 | + title="Column Selection" |
| 174 | + description="Select columns for anonymization" |
| 175 | + /> |
| 176 | + <Step |
| 177 | + status={status(NotebookNavStep.AnonymizationSummary)} |
| 178 | + title="Anonymization Summary" |
| 179 | + description="Review distortion statistics" |
| 180 | + /> |
| 181 | + <Step |
| 182 | + status={status(NotebookNavStep.AnonymizedResults)} |
| 183 | + title="Anonymized Results" |
| 184 | + description="Preview anonymized results" |
| 185 | + /> |
| 186 | + <Step status={status(NotebookNavStep.CsvExport)} title="CSV Export" description="Export anonymized data to CSV" /> |
| 187 | + </Steps> |
| 188 | + ); |
| 189 | +}; |
0 commit comments