xref: /aosp_15_r20/external/perfetto/ui/src/base/classnames.ts (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
1*6dbdd20aSAndroid Build Coastguard Worker// Copyright (C) 2023 The Android Open Source Project
2*6dbdd20aSAndroid Build Coastguard Worker//
3*6dbdd20aSAndroid Build Coastguard Worker// Licensed under the Apache License, Version 2.0 (the "License");
4*6dbdd20aSAndroid Build Coastguard Worker// you may not use this file except in compliance with the License.
5*6dbdd20aSAndroid Build Coastguard Worker// You may obtain a copy of the License at
6*6dbdd20aSAndroid Build Coastguard Worker//
7*6dbdd20aSAndroid Build Coastguard Worker//      http://www.apache.org/licenses/LICENSE-2.0
8*6dbdd20aSAndroid Build Coastguard Worker//
9*6dbdd20aSAndroid Build Coastguard Worker// Unless required by applicable law or agreed to in writing, software
10*6dbdd20aSAndroid Build Coastguard Worker// distributed under the License is distributed on an "AS IS" BASIS,
11*6dbdd20aSAndroid Build Coastguard Worker// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*6dbdd20aSAndroid Build Coastguard Worker// See the License for the specific language governing permissions and
13*6dbdd20aSAndroid Build Coastguard Worker// limitations under the License.
14*6dbdd20aSAndroid Build Coastguard Worker
15*6dbdd20aSAndroid Build Coastguard Worker// It's common to want to have a class depending on a boolean flag, in which
16*6dbdd20aSAndroid Build Coastguard Worker// case we use `flag && className` which evaluates to either false or a string,
17*6dbdd20aSAndroid Build Coastguard Worker// which is why false is included in definition of ArgType.
18*6dbdd20aSAndroid Build Coastguard Workertype ArgType = string | false | undefined;
19*6dbdd20aSAndroid Build Coastguard Worker
20*6dbdd20aSAndroid Build Coastguard Worker// Join class names together into valid HTML class attributes
21*6dbdd20aSAndroid Build Coastguard Worker// Falsy elements are ignored
22*6dbdd20aSAndroid Build Coastguard Worker// If all elements are falsy, returns undefined
23*6dbdd20aSAndroid Build Coastguard Workerexport function classNames(...args: ArgType[]) {
24*6dbdd20aSAndroid Build Coastguard Worker  // NOTE: This function is optimized for efficiency. Be very careful when
25*6dbdd20aSAndroid Build Coastguard Worker  // making changes & make sure to benchmark.
26*6dbdd20aSAndroid Build Coastguard Worker  let result = '';
27*6dbdd20aSAndroid Build Coastguard Worker  for (let i = 0; i < args.length; ++i) {
28*6dbdd20aSAndroid Build Coastguard Worker    // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
29*6dbdd20aSAndroid Build Coastguard Worker    if (args[i]) {
30*6dbdd20aSAndroid Build Coastguard Worker      result += result ? ' ' + args[i] : args[i];
31*6dbdd20aSAndroid Build Coastguard Worker    }
32*6dbdd20aSAndroid Build Coastguard Worker  }
33*6dbdd20aSAndroid Build Coastguard Worker  return result || undefined;
34*6dbdd20aSAndroid Build Coastguard Worker}
35