@carbon/ibm-products
Version:
Carbon for IBM Products
90 lines (88 loc) • 2.92 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_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/GetStartedCard/GetStartedCard.tsx
/**
* Copyright IBM Corp. 2024, 2024
*
* 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 componentName = "GetStartedCard";
/**
* GetStartedCard a card with icon, number, and media variants
*/
const GetStartedCard = react.default.forwardRef((props, ref) => {
return /* @__PURE__ */ react.default.createElement(require_Card.Card, {
...props,
ref,
getStarted: true,
...require_devtools.getDevtoolsProps(componentName)
});
});
GetStartedCard.displayName = componentName;
GetStartedCard.propTypes = {
/**
* Provide an optional class to be applied to the containing node.
*/
className: prop_types.default.string,
/**
* Optional if the card should be disabled
*/
disabled: prop_types.default.bool,
/**
* Provides the action icon that's displayed at the footer of the card
*/
/**@ts-ignore */
footerActionIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
/**
* 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,
/**
* Icons that are displayed on the card showing the time and skill needed
*/
/**@ts-ignore */
metadata: 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]),
iconDescription: prop_types.default.string
})),
/**
* Provides the callback for a clickable card
*/
onClick: prop_types.default.func.isRequired,
/**
* 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]),
/**
* Provides number for card for tasks in a sequential order
*/
sequence: prop_types.default.number,
/**
* Provides the status that's displayed at the top of the card
*/
status: prop_types.default.oneOf(["complete", "incomplete"]),
/**
* Title that's displayed at the top of the card
*/
title: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.node])
};
//#endregion
exports.GetStartedCard = GetStartedCard;