ui/src/widgets/chip.ts

// Copyright (C) 2024 The Android Open Source Project
//
// 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 m from 'mithril';
import {classNames} from '../base/classnames';
import {HTMLAttrs, Intent, classForIntent} from './common';
import {Icon} from './icon';
import {Spinner} from './spinner';

interface CommonAttrs extends HTMLAttrs {
  // Use minimal padding, reducing the overall size of the chip by a few px.
  // Defaults to false.
  compact?: boolean;
  // Optional right icon.
  rightIcon?: string;
  // List of space separated class names forwarded to the icon.
  className?: string;
  // Show loading spinner instead of icon.
  // Defaults to false.
  loading?: boolean;
  // Whether to use a filled icon
  // Defaults to false;
  iconFilled?: boolean;
  // Indicate chip colouring by intent.
  // Defaults to undefined aka "None"
  intent?: Intent;
  // Turns the chip into a pill shape.
  rounded?: boolean;
}

interface IconChipAttrs extends CommonAttrs {
  // Icon chips require an icon.
  icon: string;
}

interface LabelChipAttrs extends CommonAttrs {
  // Label chips require a label.
  label: string;
  // Label chips can have an optional icon.
  icon?: string;
}

export type ChipAttrs = LabelChipAttrs | IconChipAttrs;

export class Chip implements m.ClassComponent<ChipAttrs> {
  view({attrs}: m.CVnode<ChipAttrs>) {
    const {
      icon,
      compact,
      rightIcon,
      className,
      iconFilled,
      intent = Intent.None,
      rounded,
      ...htmlAttrs
    } = attrs;

    const label = 'label' in attrs ? attrs.label : undefined;

    const classes = classNames(
      compact && 'pf-compact',
      classForIntent(intent),
      icon && !label && 'pf-icon-only',
      className,
      rounded && 'pf-rounded',
    );

    return m(
      '.pf-chip',
      {
        ...htmlAttrs,
        className: classes,
      },
      this.renderIcon(attrs),
      rightIcon &&
        m(Icon, {
          className: 'pf-right-icon',
          icon: rightIcon,
          filled: iconFilled,
        }),
      label || '\u200B', // Zero width space keeps chip in-flow
    );
  }

  private renderIcon(attrs: ChipAttrs): m.Children {
    const {icon, iconFilled} = attrs;
    const className = 'pf-left-icon';
    if (attrs.loading) {
      return m(Spinner, {className});
    } else if (icon) {
      return m(Icon, {className, icon, filled: iconFilled});
    } else {
      return undefined;
    }
  }
}

/**
 * Space chips out with a little gap between each one.
 */
export class ChipBar implements m.ClassComponent<HTMLAttrs> {
  view({attrs, children}: m.CVnode<HTMLAttrs>): m.Children {
    return m('.pf-chip-bar', attrs, children);
  }
}