import { Interpolation, Keyframes, Theme } from '@emotion/react';
import { Location, MaterialHelpDisplay, MaterialItem, MaterialMove } from '@gamepark/rules-api';
import { TFunction } from 'i18next';
import { ComponentType, HTMLAttributes, ReactNode } from 'react';
import { ItemContext, MaterialContext } from '../../locators';
import { ComponentDescription } from './ComponentDescription';
import { ItemButtonProps } from './ItemMenuButton';
export type MaterialHelpProps<P extends number = number, M extends number = number, L extends number = number> = {
    closeDialog: () => void;
} & Omit<MaterialHelpDisplay<P, M, L>, 'type'>;
export type MaterialHelpDisplayProps<P extends number = number, M extends number = number, L extends number = number> = {
    item: Partial<MaterialItem<P, L>>;
    itemType: M;
    itemIndex?: number;
    displayIndex?: number;
    closeDialog: () => void;
};
export type MaterialContentProps<ItemId = any, M extends number = number> = {
    itemId: ItemId;
    itemIndex?: number;
    displayIndex?: number;
    type?: M;
    highlight?: boolean;
    playDown?: boolean;
    preview?: boolean;
    /**
     * What material with 2 faces displays on its back face (see {@link FlatMaterialDescription}), where children
     * are displayed on its front face. Which of the two a location goes to is decided by whoever renders the item,
     * from the face the location belongs to (see {@link Locator.getParentFace}).
     */
    backChildren?: ReactNode;
} & HTMLAttributes<HTMLElement>;
/**
 * Base class to describe the material in a game
 */
export declare abstract class MaterialDescription<P extends number = number, M extends number = number, L extends number = number, ItemId = any, R extends number = number, V extends number = number> extends ComponentDescription<ItemId> {
    /**
     * Content of the help dialog opened when an item is clicked
     */
    help?: ComponentType<MaterialHelpProps<P, M, L>>;
    /**
     * Custom component to render the item display area in the help dialog.
     * Replaces the default item rendering (left side of the dialog).
     * Use this to customize item positioning, show multiple items, add overlays, etc.
     */
    helpDisplay: ComponentType<MaterialHelpDisplayProps<P, M, L>>;
    /**
     * The React component to display
     */
    abstract content: (props: MaterialContentProps<ItemId, M>) => ReactNode;
    /**
     * If the component can be moved (token, cards...) or not (writing)
     */
    isMobile: boolean;
    /**
     * See {@link getStaticItems}
     */
    staticItem?: MaterialItem<P, L, ItemId>;
    /**
     * See {@link getStaticItems}
     */
    staticItems: MaterialItem<P, L, ItemId>[];
    /**
     * Return any items to display that are not part of the game state because they never move (board or unlimited stockpiles for instance).
     * Default value: {@link staticItem} if defined, otherwise {@link staticItems}. Override if the static items depends on the context.
     *
     * @param {MaterialContext} _context Context of the game
     * @returns {MaterialItem[]} the extra items to display
     */
    getStaticItems(_context: MaterialContext<P, M, L, R, V>): MaterialItem<P, L, ItemId>[];
    /**
     * See {@link getStockLocation}
     */
    stockLocation?: Location<P, L>;
    /**
     * If items are created of deleted, by default the animation will fade in or fade out the item quickly.
     * If you want to animate from/to a location (a stockpile for instance), implement this function or simply {@link stockLocation}.
     * @param _item Item that is getting created or deleted.
     * @param _context Context of the game
     * @returns The location to animate from/to
     */
    getStockLocation(_item: MaterialItem<P, L, ItemId>, _context: MaterialContext<P, M, L, R, V>): Location<P, L> | undefined;
    /**
     * See {@link getLocations}
     */
    location?: Location<P, L>;
    /**
     * See {@link getLocations}
     */
    locations: Location<P, L>[];
    /**
     * The internal locations of the item, for instance the spots to put material on a board.
     * Will return {@link location} by default if defined, {@link locations} otherwise.
     *
     * @param _item The item that contains the locations
     * @param _context Context of the game
     */
    getLocations(_item: MaterialItem<P, L, ItemId>, _context: ItemContext<P, M, L, R, V>): Location<P, L>[];
    /**
     * This function determines if an item can currently be dragged by the user to perform a given move.
     *
     * @param _move The move to consider
     * @param _context Context of the item
     */
    canDrag(_move: MaterialMove<P, M, L, R, V>, _context: ItemContext<P, M, L, R, V>): boolean;
    /**
     * This function determines if a move can be played by clicking for 1 second on an item
     *
     * @param move The move to consider
     * @param context Context of the item
     */
    canLongClick(move: MaterialMove<P, M, L, R, V>, context: ItemContext<P, M, L, R, V>): boolean;
    /**
     * This function determines if a move can be played by clicking on an item
     *
     * @param move The move to consider
     * @param context Context of the item
     */
    canShortClick(move: MaterialMove<P, M, L, R, V>, context: ItemContext<P, M, L, R, V>): boolean;
    /**
     * This function returns the move that should be played when clicking on an item, if any
     *
     * @param _context Context of the item
     */
    getShortClickMove(_context: ItemContext<P, M, L, R, V>): MaterialMove<P, M, L, R, V> | undefined;
    /**
     * This function returns the local move that should be played when clicking on an item, if any
     *
     * @param _context Context of the item
     */
    getShortClickLocalMove(_context: ItemContext<P, M, L, R, V>): MaterialMove<P, M, L, R, V> | undefined;
    /**
     * Thickness of the item
     */
    thickness: number;
    /**
     * Returns the thickness of the item. Default to {@link thickness}
     * @param _item the item
     * @param _context Context of the item
     * @returns {number} The thickness
     */
    getThickness(_item: MaterialItem<P, L, ItemId>, _context: ItemContext<P, M, L, R, V>): number;
    /**
     * Any extra css to add on the item
     * @param _item The item
     * @param _context Context of the item
     * @returns The css, using Emotion framework
     */
    getItemExtraCss(_item: MaterialItem<P, L, ItemId>, _context: ItemContext<P, M, L, R, V>): Interpolation<Theme>;
    /**
     * Whether the item should be highlighted
     * @param _item The item
     * @param _context Context of the item
     * @return true if the item should be highlighted
     */
    highlight(_item: MaterialItem<P, L, ItemId>, _context: ItemContext<P, M, L, R, V>): boolean | undefined;
    /**
     * The move to execute in order to display the help dialog about this item.
     * By default, open the help about this specific item, but it can be the help about the location of the item sometimes.
     * @param item The item
     * @param context Context of the item
     * @return The move to play to open the help dialog
     */
    displayHelp(item: MaterialItem<P, L, ItemId>, context: ItemContext<P, M, L, R, V>): MaterialMove<P, M, L, R, V> | undefined;
    /**
     * Whether the item shows its back face on the game table. Only material with 2 faces ever does
     * (see {@link FlatMaterialDescription}), hence false here.
     * @param _item The item
     * @param _context Context of the item
     * @returns true if the face the player sees is the back of the item
     */
    isFlippedOnTable(_item: Partial<MaterialItem<P, L, ItemId>>, _context: MaterialContext<P, M, L, R, V>): boolean;
    /**
     * Whether the item shows its back face in the help dialog. See {@link isFlippedOnTable}.
     * @param _item The item
     * @param _context Context of the item
     * @returns true if the face the player sees is the back of the item
     */
    isFlippedInDialog(_item: Partial<MaterialItem<P, L, ItemId>>, _context: MaterialContext<P, M, L, R, V>): boolean;
    /**
     * Builds the CSS transform that will be applied to the item.
     * @param item Item to position
     * @param context Context of the item
     * @returns {string[]} a list of CSS transformations
     */
    getItemTransform(item: MaterialItem<P, L, ItemId>, context: ItemContext<P, M, L, R, V>): string[];
    /**
     * Builds the CSS transform that will be applied to the item when hovered.
     * @param _item Item to position
     * @param _context Context of the item
     * @returns {string[]} a list of CSS transformations
     */
    getHoverTransform(_item: MaterialItem<P, L, ItemId>, _context: ItemContext<P, M, L, R, V>): string[];
    /**
     * Provide the locations that are required to drop an item given the legal moves that currently allow to drag the item.
     * @param context Context of the item. Use {@link getItemFromContext} to get the item from it.
     * @param dragMoves Legal moves filtered to only keep those that allows the item to be dragged
     * @return All the locations where the item can be dropped
     */
    getDropLocations(context: ItemContext<P, M, L, R, V>, dragMoves: MaterialMove<P, M, L, R, V>[]): Location<P, L>[];
    getMoveDropLocations(context: ItemContext<P, M, L, R, V>, move: MaterialMove<P, M, L, R, V>): Location<P, L>[];
    getTooltip(item: MaterialItem<P, L, ItemId>, t: TFunction, _context: ItemContext<P, M, L, R, V>): string | null | undefined;
    menuAlwaysVisible: boolean;
    isMenuAlwaysVisible(_item: MaterialItem<P, L, ItemId>, _context: ItemContext<P, M, L, R, V>): boolean;
    getItemMenu(_item: MaterialItem<P, L, ItemId>, _context: ItemContext<P, M, L, R, V>, _legalMoves: MaterialMove<P, M, L, R, V>[]): ReactNode;
    getHelpButton(item: MaterialItem<P, L, ItemId>, context: ItemContext<P, M, L, R, V>, props?: Partial<ItemButtonProps>): import("@emotion/react/jsx-runtime").JSX.Element;
    getAnimationCss(animationKeyframes: Keyframes, duration: number): Interpolation<Theme>;
    getHelpDisplayExtraCss(_item: Partial<MaterialItem<P, L, ItemId>>, _context: ItemContext<P, M, L, R, V>): Interpolation<Theme>;
}
export type MaterialDescriptionRecord<P extends number = number, M extends number = number, L extends number = number, R extends number = number, V extends number = number> = Record<M, MaterialDescription<P, M, L, any, R, V>>;