go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/milo/ui/src/common/components/timeline/context.tsx (about)

     1  // Copyright 2024 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  import { ScaleLinear, ScaleTime, TimeInterval } from 'd3';
    16  import {
    17    Dispatch,
    18    ReactNode,
    19    SetStateAction,
    20    createContext,
    21    useContext,
    22    useMemo,
    23    useState,
    24  } from 'react';
    25  
    26  export interface TimelineConfig {
    27    readonly startTimeMs: number;
    28    readonly itemCount: number;
    29    readonly itemHeight: number;
    30    readonly sidePanelWidth: number;
    31    readonly bodyWidth: number;
    32    readonly xScale: ScaleTime<number, number, never>;
    33    readonly yScale: ScaleLinear<number, number, never>;
    34    readonly timeInterval: TimeInterval;
    35  }
    36  const ConfigCtx = createContext<TimelineConfig | null>(null);
    37  
    38  interface RulerStateSetters {
    39    readonly setDisplay: Dispatch<SetStateAction<boolean>>;
    40    readonly setX: Dispatch<SetStateAction<number>>;
    41  }
    42  
    43  const RulerStateSettersCtx = createContext<RulerStateSetters | null>(null);
    44  const RulerStateCtx = createContext<number | null>(null);
    45  
    46  export interface TimelineContextProviderProps {
    47    readonly config: TimelineConfig;
    48    readonly children: ReactNode;
    49  }
    50  
    51  export function TimelineContextProvider({
    52    config,
    53    children,
    54  }: TimelineContextProviderProps) {
    55    const [rulerX, setRulerX] = useState(0);
    56    const [displayRuler, setDisplayRuler] = useState(false);
    57    const rulerStateSetters = useMemo(
    58      () => ({ setX: setRulerX, setDisplay: setDisplayRuler }),
    59      [setRulerX, setDisplayRuler],
    60    );
    61  
    62    return (
    63      <ConfigCtx.Provider value={config}>
    64        <RulerStateSettersCtx.Provider value={rulerStateSetters}>
    65          <RulerStateCtx.Provider value={displayRuler ? rulerX : null}>
    66            {children}
    67          </RulerStateCtx.Provider>
    68        </RulerStateSettersCtx.Provider>
    69      </ConfigCtx.Provider>
    70    );
    71  }
    72  
    73  export function useTimelineConfig() {
    74    const ctx = useContext(ConfigCtx);
    75    if (ctx === null) {
    76      throw new Error('useTimelineConfig can only be used within Timeline');
    77    }
    78  
    79    return ctx;
    80  }
    81  
    82  export function useRulerStateSetters() {
    83    const ctx = useContext(RulerStateSettersCtx);
    84    if (ctx === null) {
    85      throw new Error('useRulerStateSetters can only be used within Timeline');
    86    }
    87  
    88    return ctx;
    89  }
    90  
    91  export function useRulerState() {
    92    return useContext(RulerStateCtx);
    93  }