frontend/lib/src/components/widgets/DataFrame/columns/CheckboxColumn.ts - develop - vshmidt/streamlit

frontend/lib/src/components/widgets/DataFrame/columns/CheckboxColumn.ts
94 строки3 KB
Ken McGrady
Update copyright header to 2026 (#13491)
02 янв 2026, 16:21
02 янв 2026, 16:21374540a
/**
 * Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {
  BooleanCell,
  GridCell,
  GridCellKind,
} from "@glideapps/glide-data-grid"

import { convertRemToPx, EmotionTheme } from "~lib/theme"
import { isNullOrUndefined } from "~lib/util/utils"

import {
  BaseColumn,
  BaseColumnProps,
  getErrorCell,
  toSafeBoolean,
  toSafeString,
} from "./utils"

/**
 * A column type that supports optimized rendering and editing for boolean values
 * by using checkboxes.
 */
function CheckboxColumn(
  props: BaseColumnProps,
  theme: EmotionTheme
): BaseColumn {
  const cellTemplate: BooleanCell = {
    kind: GridCellKind.Boolean,
    data: false,
    allowOverlay: false, // no overlay possible
    contentAlign: props.contentAlignment,
    readonly: !props.isEditable,
    style: "normal",
  }

  return {
    ...props,
    kind: "checkbox",
    typeIcon: ":material/check_box:",
    sortMode: "default",
    themeOverride: {
      // Apply the theme's rounding radius so that it applies the correct
      // rounding radius to the checkbox based on the theme config.
      roundingRadius: Math.round(
        // Use theme value, but a maximum rounding of maxCheckbox:
        Math.min(
          convertRemToPx(theme.radii.md),
          convertRemToPx(theme.radii.maxCheckbox)
        )
      ),
    },
    getCell(data?: unknown): GridCell {
      let cellData = null

      cellData = toSafeBoolean(data)
      if (cellData === undefined) {
        return getErrorCell(
          toSafeString(data),
          `The value cannot be interpreted as boolean.`
        )
      }

      // We are not setting isMissingValue here because the checkbox column
      // does not work with the missing cell rendering.
      return {
        ...cellTemplate,
        data: cellData,
        isMissingValue: isNullOrUndefined(cellData),
      } as BooleanCell
    },
    getCellValue(cell: BooleanCell): boolean | null {
      return cell.data === undefined ? null : cell.data
    },
  }
}

CheckboxColumn.isEditableType = true

export default CheckboxColumn