/**********************************************************************
 * Copyright (C) 2022 Red Hat, Inc.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 ***********************************************************************/

export interface MenuItem {
  /**
   * Unique within a single menu.
   */
  id: string;

  type?: 'normal' | 'separator' | 'submenu' | 'checkbox' | 'radio';
  label?: string;
  sublabel?: string;
  icon?: string;
  /**
   * If false, the menu item will be greyed out and unclickable.
   */
  enabled?: boolean;
  /**
   * If false, the menu item will be entirely hidden.
   */
  visible?: boolean;
  /**
   * Should only be specified for `checkbox` or `radio` type menu items.
   */
  checked?: boolean;
}
