/**
 *
 * Card is a flexible container component.
 *
 * @module card
 *
 */
import { VNode } from 'vue';

import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import {
  ClassComponent,
  GlobalComponentConstructor,
  PassThrough,
} from '../ts-helpers.d';

export declare type CardPassThroughOptionType =
  | CardPassThroughAttributes
  | null
  | undefined;

/**
 * Custom passthrough(pt) options.
 * @see {@link CardProps.pt}
 */
export interface CardPassThroughOptions {
  /**
   * Used to pass attributes to the root's DOM element.
   */
  root?: CardPassThroughOptionType;
  /**
   * Used to pass attributes to the header's DOM element.
   */
  header?: CardPassThroughOptionType;
  /**
   * Used to pass attributes to the body's DOM element.
   */
  body?: CardPassThroughOptionType;
  /**
   * Used to pass attributes to the caption's DOM element.
   */
  caption?: CardPassThroughOptionType;
  /**
   * Used to pass attributes to the title's DOM element.
   */
  title?: CardPassThroughOptionType;
  /**
   * Used to pass attributes to the subtitle's DOM element.
   */
  subtitle?: CardPassThroughOptionType;
  /**
   * Used to pass attributes to the content's DOM element.
   */
  content?: CardPassThroughOptionType;
  /**
   * Used to pass attributes to the footer's DOM element.
   */
  footer?: CardPassThroughOptionType;
  /**
   * Used to manage all lifecycle hooks.
   * @see {@link BaseComponent.ComponentHooks}
   */
  hooks?: ComponentHooks;
}

/**
 * Custom passthrough attributes for each DOM elements
 */
export interface CardPassThroughAttributes {
  [key: string]: any;
}

/**
 * Defines valid properties in Card component.
 */
export interface CardProps {
  /**
   * Used to pass attributes to DOM elements inside the component.
   * @type {CardPassThroughOptions}
   */
  pt?: PassThrough<CardPassThroughOptions>;
  /**
   * Used to configure passthrough(pt) options of the component.
   * @type {PassThroughOptions}
   */
  ptOptions?: PassThroughOptions;
  /**
   * When enabled, it removes component related styles in the core.
   * @defaultValue false
   */
  unstyled?: boolean;
}

/**
 * Defines valid slots in Card component.
 */
export interface CardSlots {
  /**
   * Custom header template.
   */
  header(): VNode[];
  /**
   * Custom title template.
   */
  title(): VNode[];
  /**
   * Custom subtitle template.
   */
  subtitle(): VNode[];
  /**
   * Custom content template.
   */
  content(): VNode[];
  /**
   * Custom footer template.
   */
  footer(): VNode[];
}

/**
 * **WangsVue - Card**
 *
 * _Card is a flexible container component._
 *
 * --- ---
 * ![WangsVue](https://www.wangsit.id/wp-content/uploads/2023/12/cropped-Logo_Wangsid-removebg-preview-192x192.png)
 *
 * @group Component
 */
declare class Card extends ClassComponent<CardProps, CardSlots, unknown> {}

declare module '@vue/runtime-core' {
  interface GlobalComponents {
    Card: GlobalComponentConstructor<Card>;
  }
}

export default Card;