From 3748b402e5e6dcc28c7f93012300ebfbedbbd5a0 Mon Sep 17 00:00:00 2001
From: TJ Egan <tw15egan@gmail.com>
Date: Wed, 13 Dec 2023 18:02:34 +0100
Subject: [PATCH] feat(Modal): add slug to Modal, ComposedModal (#15350)

* feat(Modal): add slug to Modal, ComposedModal

* test(snapshot): update snapshots

* docs(Slug): add slug to controls table

* fix(Modal): remove shadows, use callout gradient

* test(snapshot): update snapshots

* fix(Modal): adjust background, fix conditional class
---
 .../__snapshots__/PublicAPI-test.js.snap      |  6 ++
 .../ComposedModal/ComposedModal.tsx           | 29 ++++++-
 packages/react/src/components/Modal/Modal.tsx | 23 ++++-
 .../components/Slug/Slug-examples.stories.js  | 87 ++++++++++++++++++-
 .../react/src/components/Slug/Slug.stories.js |  2 +-
 .../react/src/components/Slug/slug-story.scss |  4 +
 .../styles/scss/components/modal/_modal.scss  | 34 +++++++-
 .../styles/scss/utilities/_ai-gradient.scss   | 22 +++--
 8 files changed, 192 insertions(+), 15 deletions(-)

diff --git a/packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap b/packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap
index 647770e0d9de..157ed84b7142 100644
--- a/packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap
+++ b/packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap
@@ -1486,6 +1486,9 @@ Map {
         ],
         "type": "oneOf",
       },
+      "slug": Object {
+        "type": "node",
+      },
     },
     "render": [Function],
   },
@@ -4833,6 +4836,9 @@ Map {
         ],
         "type": "oneOf",
       },
+      "slug": Object {
+        "type": "node",
+      },
     },
     "render": [Function],
   },
diff --git a/packages/react/src/components/ComposedModal/ComposedModal.tsx b/packages/react/src/components/ComposedModal/ComposedModal.tsx
index 483bc8467273..8a44f827ef73 100644
--- a/packages/react/src/components/ComposedModal/ComposedModal.tsx
+++ b/packages/react/src/components/ComposedModal/ComposedModal.tsx
@@ -10,7 +10,7 @@ import React, {
   type RefObject,
 } from 'react';
 import { isElement } from 'react-is';
-import PropTypes from 'prop-types';
+import PropTypes, { ReactNodeLike } from 'prop-types';
 import { ModalHeader, type ModalHeaderProps } from './ModalHeader';
 import { ModalFooter, type ModalFooterProps } from './ModalFooter';
 
@@ -180,6 +180,11 @@ export interface ComposedModalProps extends HTMLAttributes<HTMLDivElement> {
   selectorsFloatingMenus?: Array<string | null | undefined>;
 
   size?: 'xs' | 'sm' | 'md' | 'lg';
+
+  /**
+   * **Experimental**: Provide a `Slug` component to be rendered inside the `ComposedModal` component
+   */
+  slug?: ReactNodeLike;
 }
 
 const ComposedModal = React.forwardRef<HTMLDivElement, ComposedModalProps>(
@@ -200,6 +205,7 @@ const ComposedModal = React.forwardRef<HTMLDivElement, ComposedModalProps>(
       selectorsFloatingMenus,
       size,
       launcherButtonRef,
+      slug,
       ...rest
     },
     ref
@@ -270,8 +276,11 @@ const ComposedModal = React.forwardRef<HTMLDivElement, ComposedModalProps>(
 
     const modalClass = cx(
       `${prefix}--modal`,
-      isOpen && 'is-visible',
-      danger && `${prefix}--modal--danger`,
+      {
+        'is-visible': isOpen,
+        [`${prefix}--modal--danger`]: danger,
+        [`${prefix}--modal--slug`]: slug,
+      },
       customClassName
     );
 
@@ -344,6 +353,14 @@ const ComposedModal = React.forwardRef<HTMLDivElement, ComposedModalProps>(
       }
     }, [open, selectorPrimaryFocus, isOpen]);
 
+    // Slug is always size `lg`
+    let normalizedSlug;
+    if (slug && slug['type']?.displayName === 'Slug') {
+      normalizedSlug = React.cloneElement(slug as React.ReactElement<any>, {
+        size: 'lg',
+      });
+    }
+
     return (
       <div
         {...rest}
@@ -369,6 +386,7 @@ const ComposedModal = React.forwardRef<HTMLDivElement, ComposedModalProps>(
             Focus sentinel
           </button>
           <div ref={innerModal} className={`${prefix}--modal-container-body`}>
+            {normalizedSlug}
             {childrenWithProps}
           </div>
           {/* Non-translatable: Focus-wrap code makes this `<button>` not actually read by screen readers */}
@@ -466,6 +484,11 @@ ComposedModal.propTypes = {
    * Specify the size variant.
    */
   size: PropTypes.oneOf(['xs', 'sm', 'md', 'lg']),
+
+  /**
+   * **Experimental**: Provide a `Slug` component to be rendered inside the `ComposedModal` component
+   */
+  slug: PropTypes.node,
 };
 
 export default ComposedModal;
diff --git a/packages/react/src/components/Modal/Modal.tsx b/packages/react/src/components/Modal/Modal.tsx
index ac4b27fa00c2..3284ad207f69 100644
--- a/packages/react/src/components/Modal/Modal.tsx
+++ b/packages/react/src/components/Modal/Modal.tsx
@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import PropTypes from 'prop-types';
+import PropTypes, { ReactNodeLike } from 'prop-types';
 import React, { useRef, useEffect } from 'react';
 import classNames from 'classnames';
 import { Close } from '@carbon/icons-react';
@@ -205,6 +205,11 @@ export interface ModalProps extends ReactAttr<HTMLDivElement> {
    * Specify the size variant.
    */
   size?: ModalSize;
+
+  /**
+   * **Experimental**: Provide a `Slug` component to be rendered inside the `Modal` component
+   */
+  slug?: ReactNodeLike;
 }
 
 const Modal = React.forwardRef(function Modal(
@@ -239,6 +244,7 @@ const Modal = React.forwardRef(function Modal(
     loadingDescription,
     loadingIconDescription,
     onLoadingSuccess = noopFn,
+    slug,
     ...rest
   }: ModalProps,
   ref: React.LegacyRef<HTMLDivElement>
@@ -323,6 +329,7 @@ const Modal = React.forwardRef(function Modal(
       [`${prefix}--modal-tall`]: !passiveModal,
       'is-visible': open,
       [`${prefix}--modal--danger`]: danger,
+      [`${prefix}--modal--slug`]: slug,
     },
     className
   );
@@ -418,6 +425,14 @@ const Modal = React.forwardRef(function Modal(
     }
   }, [open, selectorPrimaryFocus, danger, prefix]);
 
+  // Slug is always size `lg`
+  let normalizedSlug;
+  if (slug && slug['type']?.displayName === 'Slug') {
+    normalizedSlug = React.cloneElement(slug as React.ReactElement<any>, {
+      size: 'lg',
+    });
+  }
+
   const modalButton = (
     <button
       className={modalCloseButtonClass}
@@ -460,6 +475,7 @@ const Modal = React.forwardRef(function Modal(
           className={`${prefix}--modal-header__heading`}>
           {modalHeading}
         </Text>
+        {normalizedSlug}
         {!passiveModal && modalButton}
       </div>
       <div
@@ -752,6 +768,11 @@ Modal.propTypes = {
    * Specify the size variant.
    */
   size: PropTypes.oneOf(ModalSizes),
+
+  /**
+   * **Experimental**: Provide a `Slug` component to be rendered inside the `Modal` component
+   */
+  slug: PropTypes.node,
 };
 
 export default Modal;
diff --git a/packages/react/src/components/Slug/Slug-examples.stories.js b/packages/react/src/components/Slug/Slug-examples.stories.js
index 92d136f53e88..f94e2f5c8b9a 100644
--- a/packages/react/src/components/Slug/Slug-examples.stories.js
+++ b/packages/react/src/components/Slug/Slug-examples.stories.js
@@ -3,9 +3,16 @@ import Button from '../Button';
 import Checkbox from '../Checkbox';
 import CheckboxGroup from '../CheckboxGroup';
 import ComboBox from '../ComboBox';
+import {
+  ComposedModal,
+  ModalBody,
+  ModalHeader,
+  ModalFooter,
+} from '../ComposedModal';
 import DatePicker from '../DatePicker';
 import DatePickerInput from '../DatePickerInput';
 import Dropdown from '../Dropdown';
+import Modal from '../Modal';
 import { MultiSelect, FilterableMultiSelect } from '../MultiSelect';
 import { NumberInput } from '../NumberInput';
 import RadioButton from '../RadioButton';
@@ -146,7 +153,7 @@ const items = [
 ];
 
 const slug = (
-  <Slug>
+  <Slug className="slug-container">
     <SlugContent>
       <div>
         <p className="secondary">AI Explained</p>
@@ -268,6 +275,47 @@ export const _Combobox = {
   ),
 };
 
+export const _ComposedModal = {
+  argTypes: {
+    slug: {
+      description:
+        '**Experimental**: Provide a `Slug` component to be rendered inside the component',
+    },
+  },
+  render: () => (
+    <div className="slug-modal">
+      <ComposedModal slug={slug} open>
+        <ModalHeader label="Account resources" title="Add a custom domain" />
+        <ModalBody>
+          <p style={{ marginBottom: '1rem' }}>
+            Custom domains direct requests for your apps in this Cloud Foundry
+            organization to a URL that you own. A custom domain can be a shared
+            domain, a shared subdomain, or a shared domain and host.
+          </p>
+          <TextInput
+            data-modal-primary-focus
+            id="text-input-1"
+            labelText="Domain name"
+            placeholder="e.g. github.com"
+            style={{ marginBottom: '1rem' }}
+          />
+          <Select id="select-1" defaultValue="us-south" labelText="Region">
+            <SelectItem value="us-south" text="US South" />
+            <SelectItem value="us-east" text="US East" />
+          </Select>
+        </ModalBody>
+        <ModalFooter
+          primaryButtonText="Add"
+          secondaryButtons={[
+            { buttonText: 'Keep both' },
+            { buttonText: 'Rename' },
+          ]}
+        />
+      </ComposedModal>
+    </div>
+  ),
+};
+
 export const _DatePicker = {
   args: args,
   argTypes: argTypes,
@@ -327,6 +375,43 @@ export const _FilterableMultiselect = {
   ),
 };
 
+export const _Modal = {
+  argTypes: {
+    slug: {
+      description:
+        '**Experimental**: Provide a `Slug` component to be rendered inside the component',
+    },
+  },
+  render: () => (
+    <div className="slug-modal">
+      <Modal
+        open
+        modalHeading="Add a custom domain"
+        modalLabel="Account resources"
+        primaryButtonText="Add"
+        secondaryButtonText="Cancel"
+        slug={slug}>
+        <p>
+          Custom domains direct requests for your apps in this Cloud Foundry
+          organization to a URL that you own. A custom domain can be a shared
+          domain, a shared subdomain, or a shared domain and host.
+        </p>
+        <TextInput
+          data-modal-primary-focus
+          id="text-input-1"
+          labelText="Domain name"
+          placeholder="e.g. github.com"
+        />
+        <Select id="select-1" defaultValue="us-south" labelText="Region">
+          <SelectItem value="us-south" text="US South" />
+          <SelectItem value="us-east" text="US East" />
+        </Select>
+        <TextArea labelText="Comments" />
+      </Modal>
+    </div>
+  ),
+};
+
 export const _Multiselect = {
   args: args,
   argTypes: argTypes,
diff --git a/packages/react/src/components/Slug/Slug.stories.js b/packages/react/src/components/Slug/Slug.stories.js
index 4615d2872bf0..e5c5abc2fbf6 100644
--- a/packages/react/src/components/Slug/Slug.stories.js
+++ b/packages/react/src/components/Slug/Slug.stories.js
@@ -45,7 +45,7 @@ const content = <span>AI was used to generate this content</span>;
 
 export const Default = () => (
   <>
-    <div className="slug-container-example">
+    <div className="slug-container slug-container-example">
       <Slug autoAlign size="mini">
         <SlugContent>{aiContent}</SlugContent>
       </Slug>
diff --git a/packages/react/src/components/Slug/slug-story.scss b/packages/react/src/components/Slug/slug-story.scss
index cc61949b37e3..d261e5330ac2 100644
--- a/packages/react/src/components/Slug/slug-story.scss
+++ b/packages/react/src/components/Slug/slug-story.scss
@@ -141,3 +141,7 @@
 .slug-check-radio-container fieldset.cds--checkbox-group:not(:first-of-type) {
   margin-top: 2rem;
 }
+
+.slug-modal .cds--form-item {
+  margin-top: 1rem;
+}
diff --git a/packages/styles/scss/components/modal/_modal.scss b/packages/styles/scss/components/modal/_modal.scss
index a91d147ae2e2..e1cd4736baf5 100644
--- a/packages/styles/scss/components/modal/_modal.scss
+++ b/packages/styles/scss/components/modal/_modal.scss
@@ -12,6 +12,7 @@
 @use '../../spacing' as *;
 @use '../../theme' as *;
 @use '../../type' as *;
+@use '../../utilities/ai-gradient' as *;
 @use '../../utilities/convert';
 @use '../../utilities/component-reset';
 @use '../../utilities/focus-outline' as *;
@@ -155,7 +156,6 @@
   .#{$prefix}--modal-container {
     position: fixed;
     display: grid;
-    overflow: hidden;
     background-color: $layer;
     block-size: 100%;
     grid-template-columns: 100%;
@@ -485,6 +485,38 @@
     margin: 0;
   }
 
+  // Slug styles
+  .#{$prefix}--modal--slug .#{$prefix}--modal-container {
+    @include callout-gradient('default');
+
+    background-color: $layer;
+  }
+
+  // Start the gradient 64px from bottom only when two buttons are present
+  .#{$prefix}--modal--slug
+    .#{$prefix}--modal-container:has(
+      .#{$prefix}--btn-set:not(.#{$prefix}--modal-footer--three-button)
+        > button:not(:only-child)
+    ) {
+    @include callout-gradient('default', 64px);
+
+    background-color: $layer;
+  }
+
+  .#{$prefix}--modal--slug .#{$prefix}--slug {
+    position: absolute;
+    inset-block-start: 0;
+    inset-inline-end: 0;
+  }
+
+  .#{$prefix}--modal-header > .#{$prefix}--slug:has(+ .#{$prefix}--modal-close),
+  .#{$prefix}--modal-header > .#{$prefix}--modal-close ~ .#{$prefix}--slug,
+  .#{$prefix}--modal--slug
+    .#{$prefix}--modal-container-body
+    > .#{$prefix}--slug {
+    inset-inline-end: convert.to-rem(48px);
+  }
+
   // Windows HCM fix
   /* stylelint-disable */
   .#{$prefix}--modal-close__icon {
diff --git a/packages/styles/scss/utilities/_ai-gradient.scss b/packages/styles/scss/utilities/_ai-gradient.scss
index b7b80c1abe70..bd969f2c87ac 100644
--- a/packages/styles/scss/utilities/_ai-gradient.scss
+++ b/packages/styles/scss/utilities/_ai-gradient.scss
@@ -45,50 +45,56 @@
 /// @access private
 /// @example @include callout-gradient();
 /// @param {String} $type  - Type of gradient, either 'default', 'selected' or 'hover'
+/// @param {Number} $type  - specify a pixel offset the callout should start from the bottom
 /// @group utilities
-@mixin callout-gradient($type: 'default') {
+@mixin callout-gradient($type: 'default', $offset: 0) {
+  $start: 0%;
+  @if $offset != 0 {
+    $start: calc(0% + #{$offset});
+  }
+
   @if $type == 'hover' {
     background: linear-gradient(
         0deg,
-        theme.$slug-callout-aura-start-hover-01 0%,
+        theme.$slug-callout-aura-start-hover-01 $start,
         theme.$slug-callout-aura-end-hover-01 50%,
         transparent 50%
       ),
       linear-gradient(
         0deg,
-        theme.$slug-callout-aura-start-hover-02 0%,
+        theme.$slug-callout-aura-start-hover-02 $start,
         theme.$slug-callout-aura-end-hover-02 50%,
         transparent 50%
       ),
       linear-gradient(
           180deg,
-          theme.$slug-callout-gradient-top-hover 0%,
+          theme.$slug-callout-gradient-top-hover $start,
           theme.$slug-callout-gradient-bottom-hover 100%
         )
         rgba(0, 0, 0, 0.01);
   } @else if $type == 'selected' {
     background: linear-gradient(
         0deg,
-        theme.$slug-callout-aura-start-selected 0%,
+        theme.$slug-callout-aura-start-selected $start,
         theme.$slug-callout-aura-end-selected 50%,
         transparent 50%
       ),
       linear-gradient(
           180deg,
-          theme.$slug-callout-gradient-top-selected 0%,
+          theme.$slug-callout-gradient-top-selected $start,
           theme.$slug-callout-gradient-bottom-selected 100%
         )
         rgba(0, 0, 0, 0.01);
   } @else {
     background: linear-gradient(
         0deg,
-        theme.$slug-callout-aura-start 0%,
+        theme.$slug-callout-aura-start $start,
         theme.$slug-callout-aura-end 50%,
         transparent 50%
       ),
       linear-gradient(
           180deg,
-          theme.$slug-callout-gradient-top 0%,
+          theme.$slug-callout-gradient-top $start,
           theme.$slug-callout-gradient-bottom 100%
         )
         rgba(0, 0, 0, 0.01);