@react-native-ohos/flash-list/src/utils/ContentContainerUtils.ts

FlashList is a more performant FlatList replacement

/**
 * MIT License
 *
 * Copyright (C) 2024 Huawei Device Co., Ltd.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import { ViewStyle } from "react-native";
import { Dimension } from "recyclerlistview";

import { ContentStyle } from "../FlashListProps";

export interface ContentStyleExplicit {
  paddingTop: number;
  paddingBottom: number;
  paddingLeft: number;
  paddingRight: number;
  backgroundColor?: string;
}

export const updateContentStyle = (
  contentStyle: ContentStyle,
  contentContainerStyleSource: ContentStyle | undefined
): ContentStyleExplicit => {
  const {
    paddingTop,
    paddingRight,
    paddingBottom,
    paddingLeft,
    padding,
    paddingVertical,
    paddingHorizontal,
    backgroundColor,
  } = (contentContainerStyleSource ?? {}) as ViewStyle;
  contentStyle.paddingLeft = Number(
    paddingLeft || paddingHorizontal || padding || 0
  );
  contentStyle.paddingRight = Number(
    paddingRight || paddingHorizontal || padding || 0
  );
  contentStyle.paddingTop = Number(
    paddingTop || paddingVertical || padding || 0
  );
  contentStyle.paddingBottom = Number(
    paddingBottom || paddingVertical || padding || 0
  );
  contentStyle.backgroundColor = backgroundColor;
  return contentStyle as ContentStyleExplicit;
};

export const hasUnsupportedKeysInContentContainerStyle = (
  contentContainerStyleSource: ViewStyle | undefined
) => {
  const {
    paddingTop,
    paddingRight,
    paddingBottom,
    paddingLeft,
    padding,
    paddingVertical,
    paddingHorizontal,
    backgroundColor,
    ...rest
  } = (contentContainerStyleSource ?? {}) as ViewStyle;
  return Object.keys(rest).length > 0;
};

/** Applies padding corrections to given dimension. Mutates the dim object that was passed and returns it. */
export const applyContentContainerInsetForLayoutManager = (
  dim: Dimension,
  contentContainerStyle: ViewStyle | undefined,
  horizontal: boolean | undefined | null
) => {
  const contentStyle = updateContentStyle({}, contentContainerStyle);
  if (horizontal) {
    dim.height -= contentStyle.paddingTop + contentStyle.paddingBottom;
  } else {
    dim.width -= contentStyle.paddingLeft + contentStyle.paddingRight;
  }
  return dim;
};

/** Returns padding to be applied on content container and will ignore paddings that have already been handled. */
export const getContentContainerPadding = (
  contentStyle: ContentStyleExplicit,
  horizontal: boolean | undefined | null
) => {
  if (horizontal) {
    return {
      paddingTop: contentStyle.paddingTop,
      paddingBottom: contentStyle.paddingBottom,
    };
  } else {
    return {
      paddingLeft: contentStyle.paddingLeft,
      paddingRight: contentStyle.paddingRight,
    };
  }
};