@carbon/ibm-products/lib/components/CreateSidePanel/CreateSidePanel.js

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2020, 2025
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */

'use strict';

var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
var React = require('react');
var index = require('../../_virtual/index.js');
var cx = require('classnames');
var settings = require('../../settings.js');
var devtools = require('../../global/js/utils/devtools.js');
var react = require('@carbon/react');
var SidePanel = require('../SidePanel/SidePanel.js');
var uuidv4 = require('../../global/js/utils/uuidv4.js');

// The block part of our conventional BEM class names (blockClass__E--M).
const blockClass = `${settings.pkg.prefix}--create-side-panel`;
const componentName = 'CreateSidePanel';

// NOTE: the component SCSS is not imported here: it is rolled up separately.

/**
 * Use with medium complexity creations if the user needs page context. On-page content can be seen and interacted with.
 */
exports.CreateSidePanel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
  let {
    // The component props, in alphabetical order (for consistency).
    className,
    children,
    disableSubmit,
    formTitle,
    formDescription,
    id,
    onRequestClose,
    onRequestSubmit,
    open,
    primaryButtonText,
    secondaryButtonText,
    selectorPageContent,
    selectorPrimaryFocus,
    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.default();
  return selectorPageContent && /*#__PURE__*/React.createElement(SidePanel.SidePanel, _rollupPluginBabelHelpers.extends({}, rest, {
    id,
    open,
    ref,
    selectorPageContent,
    onRequestClose,
    title,
    subtitle,
    selectorPrimaryFocus
  }, devtools.getDevtoolsProps(componentName), {
    placement: "right",
    slideIn: true,
    animateTitle: false,
    className: cx(blockClass, className),
    size: "md",
    actions: actions
  }), /*#__PURE__*/React.createElement("h3", {
    className: `${blockClass}__form-title-text ${blockClass}__content-text`,
    id: formTitleId
  }, formTitle), /*#__PURE__*/React.createElement("p", {
    className: `${blockClass}__form-description-text ${blockClass}__content-text`
  }, formDescription), /*#__PURE__*/React.createElement(react.Form, {
    className: `${blockClass}__form`,
    "aria-labelledby": formTitleId
  }, children));
});
exports.CreateSidePanel = settings.pkg.checkComponentEnabled(exports.CreateSidePanel, componentName);
exports.CreateSidePanel.displayName = componentName;
exports.CreateSidePanel.propTypes = {
  /**
   * Sets the body content of the create side panel
   */
  /**@ts-ignore*/
  children: index.default.oneOfType([index.default.arrayOf(index.default.node), index.default.node]).isRequired,
  /**
   * Provide an optional class to be applied to the containing node.
   */
  className: index.default.string,
  /**
   * The description of the CreateSidePanel serves to provide more information about the form within the panel.
   */
  description: index.default.node,
  /**
   * 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: index.default.bool,
  /**
   * Specifies an optional field that provides a additional context for a form
   */
  formDescription: index.default.node,
  /**
   * Specifies a required field that provides a title for a form
   */
  formTitle: index.default.node.isRequired,
  /**
   * Unique identifier
   */
  id: index.default.string,
  /**
   * Specifies an optional handler which is called when the CreateSidePanel
   * is closed.
   */
  onRequestClose: index.default.func,
  /**
   * Specifies an optional handler which is called when the CreateSidePanel
   * primary button is pressed.
   */
  onRequestSubmit: index.default.func,
  /**
   * Specifies whether the CreateSidePanel is open or not.
   */
  /**@ts-ignore*/
  open: index.default.bool,
  /**
   * Specifies the primary button's text in the modal.
   */
  primaryButtonText: index.default.string.isRequired,
  /**
   * Specifies the secondary button's text in the modal.
   */
  secondaryButtonText: index.default.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.
   */
  selectorPageContent: index.default.string.isRequired,
  /**
   * Specifies which DOM element in the form should be focused.
   */
  /**@ts-ignore*/
  selectorPrimaryFocus: index.default.node.isRequired,
  /**
   *  **Experimental:** Provide a `Slug` component to be rendered inside the `SidePanel` component
   */
  slug: index.default.node,
  /**
   * The subtitle of the CreateSidePanel is optional and serves to provide more information about the modal.
   */
  subtitle: index.default.node,
  /**
   * The title of the CreateSidePanel is usually the product or service name.
   */
  title: index.default.string.isRequired
};