@carbon/ibm-products 1.34.1 → 1.35.0

package/es/components/EditFullPage/EditFullPage.js

@@ -1,28 +1,31 @@
 import _extends from "@babel/runtime/helpers/extends";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 var _excluded = ["children", "className"];
-
 /**
  * Copyright IBM Corp. 2022, 2022
  *
  * 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 portions of React that are needed.
-import React from 'react'; // Other standard imports.
+import React from 'react';
 
+// Other standard imports.
 import PropTypes from 'prop-types';
 import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools';
-import { pkg
-/*, carbon */
-} from '../../settings'; // Carbon and package components we use.
+import { pkg /*, carbon */ } from '../../settings';
 
+// Carbon and package components we use.
 /* TODO: @import(s) of carbon components and other package components. */
-// The block part of our conventional BEM class names (blockClass__E--M).
 
+// The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--edit-full-page");
-var componentName = 'EditFullPage'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+var componentName = 'EditFullPage';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
 // Default values can be included here and then assigned to the prop params,
 // e.g. prop = defaults.prop,
 // This gathers default values together neatly and ensures non-primitive
@@ -31,6 +34,7 @@ var componentName = 'EditFullPage'; // NOTE: the component SCSS is not imported
 // nor for props where the component can apply undefined values reasonably.
 // Default values should be provided when the component needs to make a choice
 // or assumption when a prop is not supplied.
+
 // Default values for props
 // const defaults = {
 //   /* TODO: add defaults for relevant props if needed */
@@ -39,41 +43,44 @@ var componentName = 'EditFullPage'; // NOTE: the component SCSS is not imported
 /**
  * TODO: A description of the component.
  */
-
 export var EditFullPage = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var children = _ref.children,
-      className = _ref.className,
-      rest = _objectWithoutProperties(_ref, _excluded);
-
+    className = _ref.className,
+    rest = _objectWithoutProperties(_ref, _excluded);
   return /*#__PURE__*/React.createElement("div", _extends({}, rest, {
-    className: cx(blockClass, // Apply the block class to the main HTML element
-    className, // Apply any supplied class names to the main HTML element.
+    className: cx(blockClass,
+    // Apply the block class to the main HTML element
+    className,
+    // Apply any supplied class names to the main HTML element.
     // example: `${blockClass}__template-string-class-${kind}-n-${size}`,
-    {// switched classes dependant on props or state
+    {
+      // switched classes dependant on props or state
       // example: [`${blockClass}__here-if-small`]: size === 'sm',
     }),
     ref: ref,
     role: "main"
   }, getDevtoolsProps(componentName)), children);
-}); // Return a placeholder if not released and not enabled by feature flag
+});
 
-EditFullPage = pkg.checkComponentEnabled(EditFullPage, componentName); // The display name of the component, used by React. Note that displayName
+// Return a placeholder if not released and not enabled by feature flag
+EditFullPage = pkg.checkComponentEnabled(EditFullPage, componentName);
+
+// The display name of the component, used by React. Note that displayName
 // is used in preference to relying on function.name.
+EditFullPage.displayName = componentName;
 
-EditFullPage.displayName = componentName; // The types and DocGen commentary for the component props,
+// The types and DocGen commentary for the component props,
 // in alphabetical order (for consistency).
 // See https://www.npmjs.com/package/prop-types#usage.
-
 EditFullPage.propTypes = {
   /**
    * Provide the contents of the EditFullPage.
    */
   children: PropTypes.node.isRequired,
-
   /**
    * Provide an optional class to be applied to the containing node.
    */
   className: PropTypes.string
-  /* TODO: add types and DocGen for all props. */
 
+  /* TODO: add types and DocGen for all props. */
 };

package/es/components/EditFullPage/index.js

@@ -4,4 +4,5 @@
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
+
 export { EditFullPage } from './EditFullPage';

package/es/components/EditSidePanel/EditSidePanel.js

@@ -2,65 +2,65 @@ import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 var _excluded = ["children", "className", "disableSubmit", "formTitle", "formDescription", "onRequestClose", "onRequestSubmit", "open", "placement", "primaryButtonText", "secondaryButtonText", "selectorPrimaryFocus", "selectorPageContent", "size", "slideIn", "subtitle", "title"];
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
 /**
  * Copyright IBM Corp. 2021, 2021
  *
  * 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 portions of React that are needed.
-import React from 'react'; // Other standard imports.
+import React from 'react';
 
+// Other standard imports.
 import PropTypes from 'prop-types';
 import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools';
-import { pkg
-/*, carbon */
-} from '../../settings'; // Carbon and package components we use.
+import { pkg /*, carbon */ } from '../../settings';
 
+// Carbon and package components we use.
 import { Form } from 'carbon-components-react';
 import { SidePanel } from '../SidePanel';
-import '../../global/js/utils/props-helper'; // The block part of our conventional BEM class names (blockClass__E--M).
+import '../../global/js/utils/props-helper';
 
+// The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--edit-side-panel");
-var componentName = 'EditSidePanel'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
-// Default values for props
+var componentName = 'EditSidePanel';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
 
+// Default values for props
 var defaults = {
   placement: 'right',
   size: 'md'
 };
+
 /**
  * TODO: A description of the component.
  */
-
 export var EditSidePanel = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var children = _ref.children,
-      className = _ref.className,
-      disableSubmit = _ref.disableSubmit,
-      formTitle = _ref.formTitle,
-      formDescription = _ref.formDescription,
-      onRequestClose = _ref.onRequestClose,
-      onRequestSubmit = _ref.onRequestSubmit,
-      open = _ref.open,
-      _ref$placement = _ref.placement,
-      placement = _ref$placement === void 0 ? defaults.placement : _ref$placement,
-      primaryButtonText = _ref.primaryButtonText,
-      secondaryButtonText = _ref.secondaryButtonText,
-      selectorPrimaryFocus = _ref.selectorPrimaryFocus,
-      selectorPageContent = _ref.selectorPageContent,
-      _ref$size = _ref.size,
-      size = _ref$size === void 0 ? defaults.size : _ref$size,
-      slideIn = _ref.slideIn,
-      subtitle = _ref.subtitle,
-      title = _ref.title,
-      rest = _objectWithoutProperties(_ref, _excluded);
-
+    className = _ref.className,
+    disableSubmit = _ref.disableSubmit,
+    formTitle = _ref.formTitle,
+    formDescription = _ref.formDescription,
+    onRequestClose = _ref.onRequestClose,
+    onRequestSubmit = _ref.onRequestSubmit,
+    open = _ref.open,
+    _ref$placement = _ref.placement,
+    placement = _ref$placement === void 0 ? defaults.placement : _ref$placement,
+    primaryButtonText = _ref.primaryButtonText,
+    secondaryButtonText = _ref.secondaryButtonText,
+    selectorPrimaryFocus = _ref.selectorPrimaryFocus,
+    selectorPageContent = _ref.selectorPageContent,
+    _ref$size = _ref.size,
+    size = _ref$size === void 0 ? defaults.size : _ref$size,
+    slideIn = _ref.slideIn,
+    subtitle = _ref.subtitle,
+    title = _ref.title,
+    rest = _objectWithoutProperties(_ref, _excluded);
   var actions = [{
     label: primaryButtonText,
     onClick: function onClick(event) {
@@ -98,74 +98,66 @@ export var EditSidePanel = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   }, formDescription), /*#__PURE__*/React.createElement(Form, {
     className: "".concat(blockClass, "__form")
   }, children));
-}); // Return a placeholder if not released and not enabled by feature flag
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+EditSidePanel = pkg.checkComponentEnabled(EditSidePanel, componentName);
 
-EditSidePanel = pkg.checkComponentEnabled(EditSidePanel, componentName); // The display name of the component, used by React. Note that displayName
+// The display name of the component, used by React. Note that displayName
 // is used in preference to relying on function.name.
+EditSidePanel.displayName = componentName;
 
-EditSidePanel.displayName = componentName; // The types and DocGen commentary for the component props,
+// The types and DocGen commentary for the component props,
 // in alphabetical order (for consistency).
 // See https://www.npmjs.com/package/prop-types#usage.
-
 EditSidePanel.propTypes = {
   /**
    * Sets the body content of the create side panel
    */
   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,
-
   /**
    * 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,
-
   /**
    * 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.
@@ -174,27 +166,22 @@ EditSidePanel.propTypes = {
     var slideIn = _ref2.slideIn;
     return slideIn;
   }),
-
   /**
    * Specifies which DOM element in the form should be focused.
    */
   selectorPrimaryFocus: PropTypes.node.isRequired,
-
   /**
    * Sets the size of the side panel
    */
   size: PropTypes.oneOf(['xs', 'sm', 'md', 'lg', 'max']),
-
   /**
    * Specifies which DOM element in the form should be focused.
    */
   slideIn: PropTypes.bool,
-
   /**
    * 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.
    */

package/es/components/EditSidePanel/index.js

@@ -4,4 +4,5 @@
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
+
 export { EditSidePanel } from './EditSidePanel';

package/es/components/EditTearsheet/EditTearsheet.js

@@ -2,13 +2,13 @@ import _extends from "@babel/runtime/helpers/extends";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 var _excluded = ["cancelButtonText", "children", "className", "description", "influencerWidth", "label", "onClose", "open", "submitButtonText", "title", "verticalPosition", "onHandleModalClick"];
-
 /**
  * Copyright IBM Corp. 2022, 2022
  *
  * 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 React, { forwardRef, useState, useRef, createContext } from 'react';
 import PropTypes from 'prop-types';
 import cx from 'classnames';
@@ -17,47 +17,46 @@ import { pkg } from '../../settings';
 import { getDevtoolsProps } from '../../global/js/utils/devtools';
 import { TearsheetShell } from '../Tearsheet/TearsheetShell';
 var componentName = 'EditTearsheet';
-var blockClass = "".concat(pkg.prefix, "--tearsheet-edit"); // This is a general context for the forms container
+var blockClass = "".concat(pkg.prefix, "--tearsheet-edit");
+
+// This is a general context for the forms container
 // containing information about the state of the container
 // and providing some callback methods for forms to use
+export var FormContext = /*#__PURE__*/createContext(null);
 
-export var FormContext = /*#__PURE__*/createContext(null); // This is a context supplied separately to each form in the container
+// This is a context supplied separately to each form in the container
 // to let it know what number it is in the sequence of forms
+export var FormNumberContext = /*#__PURE__*/createContext(0);
 
-export var FormNumberContext = /*#__PURE__*/createContext(0); // Default values for props
-
+// Default values for props
 var defaults = {
   verticalPosition: 'normal',
   influencerWidth: 'narrow'
 };
 export var EditTearsheet = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var cancelButtonText = _ref.cancelButtonText,
-      children = _ref.children,
-      className = _ref.className,
-      description = _ref.description,
-      _ref$influencerWidth = _ref.influencerWidth,
-      influencerWidth = _ref$influencerWidth === void 0 ? defaults.influencerWidth : _ref$influencerWidth,
-      label = _ref.label,
-      onClose = _ref.onClose,
-      open = _ref.open,
-      submitButtonText = _ref.submitButtonText,
-      title = _ref.title,
-      _ref$verticalPosition = _ref.verticalPosition,
-      verticalPosition = _ref$verticalPosition === void 0 ? defaults.verticalPosition : _ref$verticalPosition,
-      onHandleModalClick = _ref.onHandleModalClick,
-      rest = _objectWithoutProperties(_ref, _excluded);
-
+    children = _ref.children,
+    className = _ref.className,
+    description = _ref.description,
+    _ref$influencerWidth = _ref.influencerWidth,
+    influencerWidth = _ref$influencerWidth === void 0 ? defaults.influencerWidth : _ref$influencerWidth,
+    label = _ref.label,
+    onClose = _ref.onClose,
+    open = _ref.open,
+    submitButtonText = _ref.submitButtonText,
+    title = _ref.title,
+    _ref$verticalPosition = _ref.verticalPosition,
+    verticalPosition = _ref$verticalPosition === void 0 ? defaults.verticalPosition : _ref$verticalPosition,
+    onHandleModalClick = _ref.onHandleModalClick,
+    rest = _objectWithoutProperties(_ref, _excluded);
   var _useState = useState(0),
-      _useState2 = _slicedToArray(_useState, 2),
-      currentForm = _useState2[0],
-      setCurrentForm = _useState2[1];
-
+    _useState2 = _slicedToArray(_useState, 2),
+    currentForm = _useState2[0],
+    setCurrentForm = _useState2[1];
   var contentRef = useRef();
-
   var handleCurrentForm = function handleCurrentForm(form) {
     setCurrentForm(form);
   };
-
   var sideNavItems = [{
     label: 'Topic Name'
   }, {
@@ -119,81 +118,72 @@ export var EditTearsheet = /*#__PURE__*/forwardRef(function (_ref, ref) {
       value: index
     }, child);
   }))))));
-}); // Return a placeholder if not released and not enabled by feature flag
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+EditTearsheet = pkg.checkComponentEnabled(EditTearsheet, componentName);
 
-EditTearsheet = pkg.checkComponentEnabled(EditTearsheet, componentName); // The display name of the component, used by React. Note that displayName
+// The display name of the component, used by React. Note that displayName
 // is used in preference to relying on function.name.
+EditTearsheet.displayName = componentName;
 
-EditTearsheet.displayName = componentName; // Note that the descriptions here should be kept in sync with those for the
+// Note that the descriptions here should be kept in sync with those for the
 // corresponding props for TearsheetNarrow and TearsheetShell components.
-
 EditTearsheet.propTypes = {
   /**
    * The cancel button text
    */
   cancelButtonText: PropTypes.string,
-
   /**
    * The main content of the tearsheet
    */
   children: PropTypes.node,
-
   /**
    * An optional class or classes to be added to the outermost element.
    */
   className: PropTypes.string,
-
   /**
    * A description of the flow, displayed in the header area of the tearsheet.
    */
   description: PropTypes.node,
-
   /**
    * The content for the influencer section of the tearsheet, displayed
    * alongside the main content. This is typically a menu, or filter, or
    * progress indicator, or similar.
    */
   influencer: PropTypes.element,
-
   /**
    * Used to set the size of the influencer
    */
   influencerWidth: PropTypes.oneOf(['narrow', 'wide']),
-
   /**
    * A label for the tearsheet, displayed in the header area of the tearsheet
    * to maintain context for the tearsheet (e.g. as the title changes from page
    * to page of a multi-page task).
    */
   label: PropTypes.node,
-
   /**
    * An optional handler that is called when the user closes the tearsheet (by
    * clicking the close button, if enabled, or clicking outside, if enabled).
    * Returning `false` here prevents the modal from closing.
    */
   onClose: PropTypes.func,
-
   /**
    * Specifies whether the tearsheet is currently open.
    */
   onHandleModalClick: PropTypes.func,
-
   /**
    * Specifies whether the tearsheet is currently open.
    */
   open: PropTypes.bool,
-
   /**
    * The submit button text
    */
   submitButtonText: PropTypes.string,
-
   /**
    * The main title of the tearsheet, displayed in the header area.
    */
   title: PropTypes.node,
-
   /**
    * The position of the top of tearsheet in the viewport. The 'normal'
    * position (the default) is a short distance down from the top of the

package/es/components/EditTearsheet/EditTearsheetForm.js

@@ -2,13 +2,13 @@ import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 var _excluded = ["children", "className", "description", "fieldsetLegendText", "hasFieldset", "subtitle", "title"];
-
 /**
  * Copyright IBM Corp. 2022, 2022
  *
  * 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 React, { forwardRef, useContext } from 'react';
 import PropTypes from 'prop-types';
 import cx from 'classnames';
@@ -17,24 +17,23 @@ import { FormContext, FormNumberContext } from './EditTearsheet';
 import { pkg } from '../../settings';
 import pconsole from '../../global/js/utils/pconsole';
 var componentName = 'EditTearsheetForm';
-var blockClass = "".concat(pkg.prefix, "--tearsheet-edit__form"); // Default values for props
+var blockClass = "".concat(pkg.prefix, "--tearsheet-edit__form");
 
+// Default values for props
 var defaults = {
   hasFieldset: true
 };
 export var EditTearsheetForm = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var _cx;
-
   var children = _ref.children,
-      className = _ref.className,
-      description = _ref.description,
-      fieldsetLegendText = _ref.fieldsetLegendText,
-      _ref$hasFieldset = _ref.hasFieldset,
-      hasFieldset = _ref$hasFieldset === void 0 ? defaults.hasFieldset : _ref$hasFieldset,
-      subtitle = _ref.subtitle,
-      title = _ref.title,
-      rest = _objectWithoutProperties(_ref, _excluded);
-
+    className = _ref.className,
+    description = _ref.description,
+    fieldsetLegendText = _ref.fieldsetLegendText,
+    _ref$hasFieldset = _ref.hasFieldset,
+    hasFieldset = _ref$hasFieldset === void 0 ? defaults.hasFieldset : _ref$hasFieldset,
+    subtitle = _ref.subtitle,
+    title = _ref.title,
+    rest = _objectWithoutProperties(_ref, _excluded);
   var formContext = useContext(FormContext);
   var formNumber = useContext(FormNumberContext);
   return formContext ? /*#__PURE__*/React.createElement("div", _extends({}, rest, {
@@ -55,25 +54,23 @@ export var EditTearsheetForm = /*#__PURE__*/forwardRef(function (_ref, ref) {
     legendText: fieldsetLegendText,
     className: "".concat(blockClass, "--fieldset")
   }, children) : children) : pconsole.warn("You have tried using a ".concat(componentName, " component outside of a EditTearsheet. This is not allowed. ").concat(componentName, "s should always be children of the EditTearsheet"));
-}); // Return a placeholder if not released and not enabled by feature flag
+});
 
+// Return a placeholder if not released and not enabled by feature flag
 EditTearsheetForm = pkg.checkComponentEnabled(EditTearsheetForm, componentName);
 EditTearsheetForm.propTypes = {
   /**
    * Content that shows in the tearsheet form
    */
   children: PropTypes.node,
-
   /**
    * Sets an optional className to be added to the tearsheet form
    */
   className: PropTypes.string,
-
   /**
    * Sets an optional description on the form component
    */
   description: PropTypes.string,
-
   /**
    * This is the required legend text that appears above a fieldset html element for accessibility purposes.
    * You can set the `hasFieldset` prop to false if you have multiple fieldset elements or want to control the children of your Full Page's form content.
@@ -83,19 +80,16 @@ EditTearsheetForm.propTypes = {
     var hasFieldset = _ref2.hasFieldset;
     return !!hasFieldset;
   }),
-
   /**
    * This optional prop will render your form content inside of a fieldset html element
    * and is defaulted to true.
    * You can set this prop to `false` if you have multiple fieldset elements or want to control the children of your Full Page's form content.
    */
   hasFieldset: PropTypes.bool,
-
   /**
    * Sets an optional subtitle on the form component
    */
   subtitle: PropTypes.string,
-
   /**
    * Sets the title text for a tearsheet form
    */

package/es/components/EditTearsheet/index.js

@@ -4,5 +4,6 @@
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
+
 export { EditTearsheet } from './EditTearsheet';
 export { EditTearsheetForm } from './EditTearsheetForm';