@carbon/ibm-products
Version:
Carbon for IBM Products
169 lines (167 loc) • 5.32 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 { __toESM } from "../../_virtual/_rolldown/runtime.js";
import { require_classnames } from "../../node_modules/classnames/index.js";
import { pkg } from "../../settings.js";
import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
import "../../global/js/utils/props-helper.js";
import uuidv4 from "../../global/js/utils/uuidv4.js";
import { SidePanel } from "../SidePanel/SidePanel.js";
import React from "react";
import PropTypes from "prop-types";
import { Form } from "@carbon/react";
//#region src/components/EditSidePanel/EditSidePanel.tsx
var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
const blockClass = `${pkg.prefix}--edit-side-panel`;
const componentName = "EditSidePanel";
/**
* **This component is deprecated.** <br>
* Use with medium complexity edits if the user needs page context.
* @deprecated
*/
const EditSidePanel = React.forwardRef(({ children, className, disableSubmit, id, formTitle, formDescription, onRequestClose, onRequestSubmit, open, placement = "right", primaryButtonText, secondaryButtonText, selectorPrimaryFocus, selectorPageContent, size = "md", slideIn, subtitle, title, ...rest }, ref) => {
const actions = [{
label: primaryButtonText,
onClick: (event) => {
event.preventDefault();
onRequestSubmit?.();
},
kind: "primary",
disabled: disableSubmit,
type: "submit"
}, {
label: secondaryButtonText,
onClick: onRequestClose,
kind: "secondary"
}];
const formTitleId = uuidv4();
return /* @__PURE__ */ React.createElement(SidePanel, {
...rest,
open,
ref,
selectorPageContent,
onRequestClose,
title,
subtitle,
selectorPrimaryFocus,
id,
...getDevtoolsProps(componentName),
placement,
slideIn,
animateTitle: false,
className: (0, import_classnames.default)(blockClass, className),
size,
preventCloseOnClickOutside: true,
actions
}, formTitle && /* @__PURE__ */ React.createElement("h3", {
id: formTitleId,
className: `${blockClass}__form-title-text ${blockClass}__content-text`
}, formTitle), formDescription && /* @__PURE__ */ React.createElement("p", { className: `${blockClass}__form-description-text ${blockClass}__content-text` }, formDescription), /* @__PURE__ */ React.createElement(Form, {
className: `${blockClass}__form`,
"aria-labelledby": formTitleId
}, children));
});
/**@ts-ignore*/
EditSidePanel.deprecated = {
level: "warn",
details: `This component is deprecated and will be removed in the next major version.`
};
EditSidePanel.displayName = componentName;
EditSidePanel.propTypes = {
/**
* Sets the body content of the create side panel
*/
/**@ts-ignore*/
children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired,
/**
* Provide an optional class to be applied to the containing node.
*/
className: PropTypes.string,
/**
* Specifies a boolean for disabling or enabling the primary button. This is important for form validation
* Returning `true` prevents the primary button from being clicked until required fields are completed.
*/
disableSubmit: PropTypes.bool,
/**
* Specifies an optional field that provides a additional context for a form
*/
formDescription: PropTypes.node,
/**
* Specifies a required field that provides a title for a form
*/
formTitle: PropTypes.node.isRequired,
/**
* Unique identifier
*/
id: PropTypes.string,
/**
* Specifies an optional handler which is called when the CreateSidePanel
* is closed.
*/
onRequestClose: PropTypes.func,
/**
* Specifies an optional handler which is called when the CreateSidePanel
* primary button is pressed.
*/
onRequestSubmit: PropTypes.func,
/**
* Specifies whether the CreateSidePanel is open or not.
*/
open: PropTypes.bool.isRequired,
/**
* Determines if the side panel is on the right or left
*/
placement: PropTypes.oneOf(["left", "right"]),
/**
* Specifies the primary button's text in the modal.
*/
primaryButtonText: PropTypes.string.isRequired,
/**
* Specifies the secondary button's text in the modal.
*/
secondaryButtonText: PropTypes.string.isRequired,
/**
* This is the selector to the element that contains all of the page content that will shrink if the panel is a slide in.
* This prop is required when using the `slideIn` variant of the side panel.
*/
/**@ts-ignore*/
selectorPageContent: PropTypes.string,
/**
* Specifies which DOM element in the form should be focused.
*/
/**@ts-ignore*/
selectorPrimaryFocus: PropTypes.node.isRequired,
/**
* Sets the size of the side panel
*/
size: PropTypes.oneOf([
"xs",
"sm",
"md",
"lg",
"2xl"
]),
/**
* Specifies which DOM element in the form should be focused.
*/
slideIn: PropTypes.bool,
/**
* **Experimental:** Provide a `Slug` component to be rendered inside the `SidePanel` component
*/
slug: PropTypes.node,
/**
* The subtitle of the CreateSidePanel is optional and serves to provide more information about the modal.
*/
subtitle: PropTypes.node,
/**
* The title of the CreateSidePanel is usually the product or service name.
*/
/**@ts-ignore*/
title: PropTypes.node.isRequired
};
//#endregion
export { EditSidePanel };