@carbon/ibm-products
Version:
Carbon for IBM Products
172 lines (170 loc) • 5.42 kB
JavaScript
/**
* Copyright IBM Corp. 2020, 2026
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
import { prepareProps } from "../../global/js/utils/props-helper.js";
import { Card } from "../Card/Card.js";
import React, { forwardRef } from "react";
import PropTypes from "prop-types";
//#region src/components/ProductiveCard/ProductiveCard.tsx
const componentName = "ProductiveCard";
const ProductiveCard = forwardRef(({ actionsPlacement = "top", children, ...rest }, ref) => {
const validProps = prepareProps(rest, [
"media",
"mediaPosition",
"pictogram",
"primaryButtonClick",
"productive",
"secondaryButtonKind"
]);
return /* @__PURE__ */ React.createElement(Card, {
...validProps,
actionsPlacement,
ref,
productive: true,
...getDevtoolsProps(componentName)
}, children);
});
ProductiveCard.propTypes = {
/**
* Icons that are displayed on the card. Refer to design documentation for implementation guidelines. Note: href is deprecated. Set link.href for href functionality. If you are setting link object, href is a required property. link object supports all anchor element properties. Precedence: link.href > href. If link.href or href is set => anchor element, else button.
*/
/**@ts-ignore */
actionIcons: PropTypes.arrayOf(PropTypes.shape({
id: PropTypes.string,
icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
onKeyDown: PropTypes.func,
onClick: PropTypes.func,
iconDescription: PropTypes.string,
/**
* @deprecated please use the `link.href` instead
*/
href: PropTypes.string,
link: PropTypes.shape({ href: PropTypes.string.isRequired })
})),
/**
* Determines if the action icons are on the top or bottom of the card
*/
actionsPlacement: PropTypes.oneOf(["top", "bottom"]),
/**
* Content that shows in the body of the card
*/
children: PropTypes.node,
/**
* Optional user provided class
*/
className: PropTypes.string,
/**
* Designates which zones of the card are clickable. Refer to design documentation for implementation guidelines
*/
clickZone: PropTypes.oneOf([
"one",
"two",
"three"
]),
/**
* Optional prop that allows you to pass any component.
*/
decorator: PropTypes.oneOfType([PropTypes.node, PropTypes.bool]),
/**
* Optional header description
*/
description: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
/**
* Sets the text for the OverflowMenu trigger button tooltip and OverflowMenu aria label,
* gets overridden by the `overflowAriaLabel` prop.
*
* @deprecated Please use the `overflowAriaLabel` prop instead.
*/
iconDescription: PropTypes.string,
/**
* Optional label for the top of the card
*/
label: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
/**
* Provides the callback for a clickable card
*/
onClick: PropTypes.func,
/**
* Function that's called from the primary button or action icon
*/
onPrimaryButtonClick: PropTypes.func,
/**
* Function that's called from the secondary button or action icon
*/
onSecondaryButtonClick: PropTypes.func,
/**
* Use an overflow menu instead of action icons. Refer to design documentation for implementation guidelines
*/
/**@ts-ignore */
overflowActions: PropTypes.arrayOf(PropTypes.shape({
id: PropTypes.string,
itemText: PropTypes.string,
onClick: PropTypes.func,
onKeyDown: PropTypes.func
})),
/**
* Sets the text for the OverflowMenu aria label and the OverflowMenu trigger button tooltip.
* Overrides `iconDescription` prop.
*/
overflowAriaLabel: PropTypes.string,
/**
* Determines if the primary button is enabled or not
*/
primaryButtonDisabled: PropTypes.bool,
/**
* Optionally specify an href for your Button to become an <a> element
*/
primaryButtonHref: PropTypes.string,
/**
* Optional prop to allow overriding the icon rendering. Can be a React component class
*/
/**@ts-ignore */
primaryButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
/**
* Determines if the primary button is on the top or bottom of the card
*/
primaryButtonPlacement: PropTypes.oneOf(["top", "bottom"]),
/**
* The text that's displayed in the primary button
*/
/**@ts-ignore */
primaryButtonText: PropTypes.node,
/**
* Optionally specify an href for your Button to become an <a> element
*/
secondaryButtonHref: PropTypes.string,
/**
* Optional prop to allow overriding the icon rendering. Can be a React component class
*/
/**@ts-ignore */
secondaryButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
/**
* Determines if the secondary button is on the top or bottom of the card
*/
secondaryButtonPlacement: PropTypes.oneOf(["top", "bottom"]),
/**
* The text that's displayed in the secondary button
*/
/**@ts-ignore */
secondaryButtonText: PropTypes.node,
/**
* **Experimental:** For all cases a `Slug` component can be provided.
* Clickable tiles only accept a boolean value of true and display a hollow slug.
*/
slug: PropTypes.oneOfType([PropTypes.node, PropTypes.bool]),
/**
* Title that's displayed at the top of the card
*/
title: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
/**
* Determines title size
*/
titleSize: PropTypes.oneOf(["default", "large"])
};
ProductiveCard.displayName = componentName;
//#endregion
export { ProductiveCard };