go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/milo/ui/src/build/legacy/build_page/common.ts (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  export enum BuildPageTab {
    16    Overview = 'overview',
    17    TestResults = 'test-results',
    18    Steps = 'steps',
    19    RelatedBuilds = 'related-builds',
    20    Timeline = 'timeline',
    21    Blamelist = 'blamelist',
    22  }
    23  
    24  /**
    25   * The *default* "default tab" of the build page.
    26   *
    27   * The default tab of the build page can be customized by the user. This value
    28   * is the value of the default tab if it has not been customized by the user.
    29   */
    30  export const INITIAL_DEFAULT_TAB = BuildPageTab.Overview;
    31  
    32  /**
    33   * Parse the tab string into the `BuildPageTab` enum. If the tab string is
    34   * invalid, return null.
    35   */
    36  export function parseTab(tab: string): BuildPageTab | null {
    37    if (Object.values(BuildPageTab).includes(tab as BuildPageTab)) {
    38      return tab as BuildPageTab;
    39    }
    40    return null;
    41  }