@carbon/ibm-products
Version:
Carbon for IBM Products
141 lines (139 loc) • 5.1 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.
*/
const require_runtime = require("../../_virtual/_rolldown/runtime.js");
const require_devtools = require("../../global/js/utils/devtools.js");
const require_props_helper = require("../../global/js/utils/props-helper.js");
const require_Card = require("../Card/Card.js");
let react = require("react");
react = require_runtime.__toESM(react);
let prop_types = require("prop-types");
prop_types = require_runtime.__toESM(prop_types);
//#region src/components/ExpressiveCard/ExpressiveCard.tsx
const componentName = "ExpressiveCard";
const ExpressiveCard = (0, react.forwardRef)((props, ref) => {
const validProps = require_props_helper.prepareProps(props, [
"actionIconsPosition",
"overflowActions",
"productive",
"titleSize"
]);
return /* @__PURE__ */ react.default.createElement(require_Card.Card, {
ref,
...validProps,
...require_devtools.getDevtoolsProps(componentName)
});
});
ExpressiveCard.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: prop_types.default.arrayOf(prop_types.default.shape({
id: prop_types.default.string,
icon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
onKeyDown: prop_types.default.func,
onClick: prop_types.default.func,
iconDescription: prop_types.default.string,
/**
* @deprecated please use the `link.href` instead
*/
href: prop_types.default.string,
link: prop_types.default.shape({ href: prop_types.default.string.isRequired })
})),
/**
* Content that shows in the body of the card
*/
children: prop_types.default.node,
/**
* Optional user provided class
*/
className: prop_types.default.string,
/**
* Optional prop that allows you to pass any component.
*/
decorator: prop_types.default.oneOfType([prop_types.default.node, prop_types.default.bool]),
/**
* Optional header description
*/
description: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.node]),
/**
* Optional label for the top of the card
*/
label: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.node]),
/**
* Optional media content like an image to be placed in the card
*/
media: prop_types.default.node,
/**
* Establishes the position of the media in the card
*/
mediaPosition: prop_types.default.oneOf(["top", "left"]),
/**
* Provides the callback for a clickable card
*/
onClick: prop_types.default.func,
/**
* Function that's called from the primary button or action icon
*/
onPrimaryButtonClick: prop_types.default.func,
/**
* Function that's called from the secondary button
*/
onSecondaryButtonClick: prop_types.default.func,
/**
* Provides the icon that's displayed at the top of the card
*/
/**@ts-ignore */
pictogram: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
/**
* Optionally specify an href for your Button to become an <a> element
*/
primaryButtonHref: prop_types.default.string,
/**
* Optional prop to allow overriding the icon rendering. Can be a React component class
*/
/**@ts-ignore */
primaryButtonIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
/**
* Establishes the kind of button displayed for the primary button
*/
primaryButtonKind: prop_types.default.oneOf(["primary", "ghost"]),
/**
* The text that's displayed in the primary button
*/
primaryButtonText: prop_types.default.string,
/**
* Optionally specify an href for your Button to become an <a> element
*/
secondaryButtonHref: prop_types.default.string,
/**
* Optional prop to allow overriding the icon rendering. Can be a React component class
*/
/**@ts-ignore */
secondaryButtonIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
/**
* Establishes the kind of button displayed for the secondary button
*/
secondaryButtonKind: prop_types.default.oneOf(["secondary", "ghost"]),
/**
* The text that's displayed in the secondary button
*/
secondaryButtonText: prop_types.default.string,
/**
* **Experimental:** For all cases a `Slug` component can be provided.
* Clickable tiles only accept a boolean value of true and display a hollow slug.
* @deprecated please use the `decorator` prop
*/
slug: prop_types.default.oneOfType([prop_types.default.node, prop_types.default.bool]),
/**
* Title that's displayed at the top of the card
*/
title: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.node])
};
ExpressiveCard.displayName = componentName;
//#endregion
exports.ExpressiveCard = ExpressiveCard;