@carbon/ibm-products 2.80.0 → 2.81.0-rc.0

package/es/components/EditInPlace/EditInPlace.js

@@ -1,314 +0,0 @@
-/**
- * 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.
- */
-
-import { extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
-import { WarningFilled, Close, Checkmark, Edit } from '@carbon/react/icons';
-import React__default, { forwardRef, useState, useRef, useEffect } from 'react';
-import { pkg } from '../../settings.js';
-import { usePrefix, IconButton } from '@carbon/react';
-import PropTypes from '../../_virtual/index.js';
-import cx from 'classnames';
-import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
-
-var _Close, _Checkmark, _Edit;
-const componentName = 'EditInPlace';
-const blockClass = `${pkg.prefix}--edit-in-place`;
-const defaults = {
-  tooltipAlignment: 'top'};
-const EditInPlace = /*#__PURE__*/forwardRef((_ref, ref) => {
-  let {
-    cancelLabel,
-    editAlwaysVisible,
-    editLabel,
-    id,
-    inheritTypography,
-    invalid,
-    invalidLabel: deprecated_invalidLabel = ' ',
-    invalidText,
-    labelText,
-    onCancel,
-    onChange,
-    onSave,
-    onBlur,
-    // readOnly,
-    // readOnlyLabel,
-    saveLabel,
-    size = 'sm',
-    tooltipAlignment,
-    value,
-    placeholder,
-    ...rest
-  } = _ref;
-  const [focused, setFocused] = useState(false);
-  const [initialValue, setInitialValue] = useState('');
-  const [dirtyInput, setDirtyInput] = useState(false);
-  const inputRef = useRef(null);
-  const canSave = value !== initialValue && !invalid;
-  const escaping = useRef(false);
-  const carbonPrefix = usePrefix();
-  const tipAlignIsObject = typeof tooltipAlignment === 'object';
-  const tipAlignments = ['edit', 'save', 'cancel'].reduce((acc, tips) => {
-    acc[tips] = (tipAlignIsObject ? tooltipAlignment[tips] : tooltipAlignment) ?? defaults.tooltipAlignment;
-    return acc;
-  }, {});
-  useEffect(() => {
-    if (!initialValue && !dirtyInput) {
-      setInitialValue(value);
-    }
-  }, [initialValue, dirtyInput, value]);
-  const isTargetingChild = _ref2 => {
-    let {
-      currentTarget,
-      relatedTarget
-    } = _ref2;
-    return currentTarget.contains(relatedTarget);
-  };
-  const onChangeHandler = _ref3 => {
-    let {
-      target
-    } = _ref3;
-    if (!dirtyInput) {
-      setDirtyInput(true);
-    }
-    onChange(target.value);
-  };
-  const onFocusHandler = e => {
-    // if (readOnly) {
-    //   return;
-    // }
-
-    if (!isTargetingChild(e)) {
-      inputRef.current?.focus();
-      setFocused(true);
-    }
-  };
-  const onSaveHandler = () => {
-    setInitialValue(value);
-    setDirtyInput(false);
-    onSave();
-    setFocused(false);
-  };
-  const onCancelHandler = () => {
-    setDirtyInput(false);
-    onCancel(initialValue);
-  };
-  const onBlurHandler = e => {
-    // Use custom function provided if passed through
-    if (typeof onBlur === 'function' && !isTargetingChild(e)) {
-      onBlur(initialValue);
-      setFocused(false);
-    } else {
-      // Use Default behavior if no custom function provided
-      if (escaping.current) {
-        return;
-      }
-      if (!isTargetingChild(e)) {
-        if (canSave) {
-          onSaveHandler();
-        } else {
-          onCancelHandler();
-          setFocused(false);
-        }
-      }
-    }
-  };
-  const returnHandler = () => {
-    if (canSave) {
-      onSaveHandler();
-    }
-  };
-  const escapeHandler = () => {
-    onCancelHandler();
-  };
-  const removeFocus = () => {
-    inputRef.current?.blur();
-    setFocused(false);
-  };
-  const onKeyHandler = e => {
-    // to prevent blur handler from being called twice add additional state to check if escape is being used
-    escaping.current = true;
-    switch (e.key) {
-      case 'Escape':
-        removeFocus();
-        escapeHandler();
-        break;
-      case 'Enter':
-        removeFocus();
-        returnHandler();
-        break;
-    }
-    escaping.current = false;
-  };
-  return /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
-    ref: ref
-  }, getDevtoolsProps(componentName)), /*#__PURE__*/React__default.createElement("div", {
-    className: cx(blockClass, `${blockClass}--${size}`, {
-      [`${blockClass}--focused`]: focused,
-      [`${blockClass}--invalid`]: invalid,
-      [`${blockClass}--inherit-type`]: inheritTypography,
-      [`${blockClass}--overflows`]: inputRef.current && inputRef.current.scrollWidth > inputRef.current.offsetWidth
-      // [`${blockClass}--readonly`]: readOnly,
-    }),
-    onFocus: onFocusHandler,
-    onBlur: onBlurHandler
-  }, /*#__PURE__*/React__default.createElement("input", {
-    id: id,
-    className: cx(`${blockClass}__text-input`, `${carbonPrefix}--text-input`, `${carbonPrefix}--text-input--${size}`),
-    type: "text",
-    placeholder: placeholder,
-    value: value,
-    onChange: onChangeHandler,
-    ref: inputRef
-    // readOnly={readOnly}
-    ,
-    onKeyDown: onKeyHandler,
-    "aria-label": labelText,
-    "aria-invalid": invalid
-  }), /*#__PURE__*/React__default.createElement("div", {
-    className: `${blockClass}__toolbar`
-  }, invalid && /*#__PURE__*/React__default.createElement(WarningFilled, {
-    size: 16,
-    className: `${blockClass}__warning-icon`
-  }), focused ? /*#__PURE__*/React__default.createElement(React__default.Fragment, null, /*#__PURE__*/React__default.createElement(IconButton, {
-    align: tipAlignments.cancel,
-    size: size,
-    label: cancelLabel,
-    onClick: onCancelHandler,
-    kind: "ghost",
-    key: "cancel",
-    className: `${blockClass}__btn ${blockClass}__btn-cancel`
-  }, _Close || (_Close = /*#__PURE__*/React__default.createElement(Close, {
-    size: 16
-  }))), /*#__PURE__*/React__default.createElement(IconButton, {
-    align: tipAlignments.save,
-    size: size,
-    label: saveLabel,
-    onClick: onSaveHandler,
-    kind: "ghost",
-    key: "save",
-    className: `${blockClass}__btn ${blockClass}__btn-save`,
-    disabled: !canSave
-  }, _Checkmark || (_Checkmark = /*#__PURE__*/React__default.createElement(Checkmark, {
-    size: 16
-  })))) : /*#__PURE__*/React__default.createElement(IconButton, {
-    align: tipAlignments.edit,
-    className: cx(`${blockClass}__btn`, `${blockClass}__btn-edit`, {
-      [`${blockClass}__btn-edit--always-visible`]: editAlwaysVisible
-    }),
-    size: size,
-    label: editLabel,
-    onClick: onFocusHandler,
-    kind: "ghost",
-    key: "edit"
-  }, _Edit || (_Edit = /*#__PURE__*/React__default.createElement(Edit, {
-    size: 16
-  }))))), invalid && /*#__PURE__*/React__default.createElement("p", {
-    className: `${blockClass}__warning-text`
-  }, invalidText ?? deprecated_invalidLabel));
-});
-EditInPlace.displayName = componentName;
-const deprecatedProps = {
-  /**
-   * **Deprecated**
-   * invalidLabel was misnamed, using invalidText to match Carbon
-   */
-  invalidText: PropTypes.string
-};
-const alignPropType = PropTypes.oneOf(['top', 'top-left', 'top-right', 'bottom', 'bottom-left', 'bottom-right', 'left', 'right']);
-EditInPlace.propTypes = {
-  /**
-   * label for cancel button
-   */
-  cancelLabel: PropTypes.string.isRequired,
-  /**
-   * By default the edit icon is shown on hover only.
-   */
-  editAlwaysVisible: PropTypes.bool,
-  /**
-   * label for edit button
-   */
-  editLabel: PropTypes.string.isRequired,
-  /**
-   * Specify a custom id for the input
-   */
-  id: PropTypes.string.isRequired,
-  /**
-   * inheritTypography - causes the text entry field to inherit typography settings
-   * assigned to the container. This is useful when editing titles for instance.
-   *
-   * NOTE: The size property limits the vertical size of the input element.
-   * Inherited font's should be selected to fit within the size selected.
-   */
-  inheritTypography: PropTypes.bool,
-  /**
-   * determines if the input is invalid
-   */
-  invalid: PropTypes.bool,
-  /**
-   * text that is displayed if the input is invalid
-   */
-  /**@ts-ignore*/
-  invalidText: PropTypes.string,
-  /**
-   * Provide the text that will be read by a screen reader when visiting this control
-   */
-  labelText: PropTypes.string.isRequired,
-  /**
-   * handler to add custom onBlur event
-   */
-  onBlur: PropTypes.func,
-  /**
-   * handler that is called when the cancel button is pressed or when the user removes focus from the input and there is no new value
-   */
-  onCancel: PropTypes.func.isRequired,
-  /**
-   * handler that is called when the input is updated
-   */
-  onChange: PropTypes.func.isRequired,
-  /**
-   * handler that is called when the save button is pressed or when the user removes focus from the input if it has a new value
-   */
-  onSave: PropTypes.func.isRequired,
-  /**
-   * Placeholder for text input
-   */
-  placeholder: PropTypes.string,
-  /**
-   * determines if the input is in readOnly mode
-   */
-  // readOnly: PropTypes.bool,
-  /**
-   * label for the edit button that displays when in read only mode
-   */
-  // readOnlyLabel: PropTypes.string,
-  /**
-   * label for save button
-   */
-  saveLabel: PropTypes.string.isRequired,
-  /**
-   * vertical size of control
-   */
-  size: PropTypes.oneOf(['sm', 'md', 'lg']),
-  /**
-   * tooltipAlignment from the standard tooltip. Default center.
-   *
-   * Can be passed either as one of tooltip options or as an object specifying cancel, edit and save separately
-   */
-  /**@ts-ignore*/
-  tooltipAlignment: PropTypes.oneOfType([alignPropType, PropTypes.shape({
-    cancel: alignPropType,
-    edit: alignPropType,
-    save: alignPropType
-  })]),
-  /**
-   * current value of the input
-   */
-  value: PropTypes.string.isRequired,
-  ...deprecatedProps
-};
-
-export { EditInPlace, deprecatedProps };

package/es/components/EditInPlace/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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.
- */
-export { EditInPlace } from './EditInPlace';
-export type { EditInplaceProps } from './EditInPlace';

package/es/components/EditSidePanel/EditSidePanel.d.ts

@@ -1,96 +0,0 @@
-/**
- * Copyright IBM Corp. 2021, 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.
- */
-import '../../global/js/utils/props-helper';
-import React, { ReactNode } from 'react';
-export interface EditSidePanelProps {
-    /**
-     * Sets the body content of the create side panel
-     */
-    children: ReactNode;
-    /**
-     * Provide an optional class to be applied to the containing node.
-     */
-    className?: 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?: boolean;
-    /**
-     * Specifies an optional field that provides a additional context for a form
-     */
-    formDescription?: ReactNode;
-    /**
-     * Specifies a required field that provides a title for a form
-     */
-    formTitle: ReactNode;
-    /**
-     * Unique identifier
-     */
-    id?: string;
-    /**
-     * Specifies an optional handler which is called when the CreateSidePanel
-     * is closed.
-     */
-    onRequestClose?: () => void;
-    /**
-     * Specifies an optional handler which is called when the CreateSidePanel
-     * primary button is pressed.
-     */
-    onRequestSubmit?: () => void;
-    /**
-     * Specifies whether the CreateSidePanel is open or not.
-     */
-    open: boolean;
-    /**
-     * Determines if the side panel is on the right or left
-     */
-    placement?: 'left' | 'right';
-    /**
-     * Specifies the primary button's text in the modal.
-     */
-    primaryButtonText: string;
-    /**
-     * Specifies the secondary button's text in the modal.
-     */
-    secondaryButtonText: string;
-    /**
-     * 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?: string;
-    /**
-     * Specifies which DOM element in the form should be focused.
-     */
-    selectorPrimaryFocus?: string;
-    /**
-     * Sets the size of the side panel
-     */
-    size?: 'xs' | 'sm' | 'md' | 'lg' | '2xl';
-    /**
-     * Specifies which DOM element in the form should be focused.
-     */
-    slideIn?: boolean;
-    /**
-     *  **Experimental:** Provide a `Slug` component to be rendered inside the `SidePanel` component
-     */
-    slug?: ReactNode;
-    /**
-     * The subtitle of the CreateSidePanel is optional and serves to provide more information about the modal.
-     */
-    subtitle?: ReactNode;
-    /**
-     * The title of the CreateSidePanel is usually the product or service name.
-     */
-    title: string;
-}
-/**
- * **This component is deprecated.** <br>
- * Use with medium complexity edits if the user needs page context.
- * @deprecated
- */
-export declare const EditSidePanel: React.ForwardRefExoticComponent<EditSidePanelProps & React.RefAttributes<HTMLDivElement>>;

package/es/components/EditSidePanel/EditSidePanel.js

@@ -1,200 +0,0 @@
-/**
- * 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.
- */
-
-import { extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
-import '../../global/js/utils/props-helper.js';
-import React__default from 'react';
-import { Form } from '@carbon/react';
-import PropTypes from '../../_virtual/index.js';
-import { SidePanel } from '../SidePanel/SidePanel.js';
-import cx from 'classnames';
-import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
-import { pkg } from '../../settings.js';
-import uuidv4 from '../../global/js/utils/uuidv4.js';
-
-// The block part of our conventional BEM class names (blockClass__E--M).
-const blockClass = `${pkg.prefix}--edit-side-panel`;
-const componentName = 'EditSidePanel';
-
-// NOTE: the component SCSS is not imported here: it is rolled up separately.
-
-/**
- * **This component is deprecated.** <br>
- * Use with medium complexity edits if the user needs page context.
- * @deprecated
- */
-const EditSidePanel = /*#__PURE__*/React__default.forwardRef((_ref, ref) => {
-  let {
-    // The component props, in alphabetical order (for consistency).
-
-    children,
-    className,
-    disableSubmit,
-    id,
-    formTitle,
-    formDescription,
-    onRequestClose,
-    onRequestSubmit,
-    open,
-    placement = 'right',
-    primaryButtonText,
-    secondaryButtonText,
-    selectorPrimaryFocus,
-    selectorPageContent,
-    size = 'md',
-    slideIn,
-    subtitle,
-    title,
-    // Collect any other property values passed in.
-    ...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__default.createElement(SidePanel, _extends({}, rest, {
-    open,
-    ref,
-    selectorPageContent,
-    onRequestClose,
-    title,
-    subtitle,
-    selectorPrimaryFocus,
-    id
-  }, getDevtoolsProps(componentName), {
-    placement: placement,
-    slideIn: slideIn,
-    animateTitle: false,
-    className: cx(blockClass, className),
-    size: size,
-    preventCloseOnClickOutside: true,
-    actions: actions
-  }), formTitle && /*#__PURE__*/React__default.createElement("h3", {
-    id: formTitleId,
-    className: `${blockClass}__form-title-text ${blockClass}__content-text`
-  }, formTitle), formDescription && /*#__PURE__*/React__default.createElement("p", {
-    className: `${blockClass}__form-description-text ${blockClass}__content-text`
-  }, formDescription), /*#__PURE__*/React__default.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.`
-};
-
-// Return a placeholder if not released and not enabled by feature flag
-
-// The display name of the component, used by React. Note that displayName
-// is used in preference to relying on function.name.
-EditSidePanel.displayName = componentName;
-
-// 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
-   */
-  /**@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
-};
-
-export { EditSidePanel };

package/es/components/EditSidePanel/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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.
- */
-export { EditSidePanel } from './EditSidePanel';
-export type { EditSidePanelProps } from './EditSidePanel';