carbon-react/esm/components/pod/pod.component.d.ts

A library of reusable React components for easily building user interfaces.

import React from "react";
import { MarginProps } from "styled-system";
import { TagProps } from "../../__internal__/utils/helpers/tags";
import { PodAlignment, PodSize, PodVariant } from "./pod.config";
/**
 * @deprecated `Pod` has been deprecated. See the Carbon documentation for migration details.
 */
export interface PodProps extends MarginProps, TagProps {
    /** Aligns the title to left, right or center */
    alignTitle?: PodAlignment;
    /** Enables/disables the border around the pod. */
    border?: boolean;
    /** Children elements */
    children?: React.ReactNode;
    /** Determines the padding around the pod */
    size?: PodSize;
    /** Prop to apply a theme to the Pod */
    variant?: PodVariant;
    /** Title for the pod */
    title?: React.ReactNode;
    /** Optional subtitle for the pod */
    subtitle?: React.ReactNode;
    /** A component to render as a Pod footer */
    footer?: string | React.ReactNode;
    /** Supplies an edit action to the pod */
    onEdit?: (ev: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>) => void;
    /** Supplies a delete action to the pod */
    onDelete?: (ev: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>) => void;
    /** Supplies an undo action to the pod in soft delete state. */
    onUndo?: (ev: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>) => void;
    /** Sets soft boolean delete state */
    softDelete?: boolean;
    /** Determines if the editable pod content should be full width */
    editContentFullWidth?: boolean;
    /** Determines if the edit button should be hidden until the user hovers over the content */
    displayEditButtonOnHover?: boolean;
    /** Determines if clicking the pod content calls the onEdit action */
    triggerEditOnContent?: boolean;
    /** Sets Pod height, number is changed to pixels and string is passed as raw css value */
    height?: string | number;
    /** Renders edit button inside the pod if it exists. */
    internalEditButton?: boolean;
}
/**
 * @deprecated `Pod` has been deprecated. See the Carbon documentation for migration details.
 */
declare const Pod: React.ForwardRefExoticComponent<PodProps & React.RefAttributes<HTMLDivElement>>;
export default Pod;