go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/milo/ui/src/build/legacy/build_page/context.tsx (about)

     1  // Copyright 2023 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 { ReactNode, createContext, useContext } from 'react';
    16  
    17  import { Build } from '@/common/services/buildbucket';
    18  
    19  // Use `undefined` to denote missing context provider.
    20  // `null` means there's no build.
    21  const BuildCtx = createContext<Build | null | undefined>(undefined);
    22  
    23  export interface BuildProviderProps {
    24    readonly build: Build | null;
    25    readonly children: ReactNode;
    26  }
    27  
    28  export function BuildContextProvider({ build, children }: BuildProviderProps) {
    29    return <BuildCtx.Provider value={build}>{children}</BuildCtx.Provider>;
    30  }
    31  
    32  export function useBuild() {
    33    const ctx = useContext(BuildCtx);
    34    if (ctx === undefined) {
    35      throw new Error('useBuild can only be used in a BuildContextProvider');
    36    }
    37    return ctx;
    38  }