@gitlab/ui 42.16.0 → 42.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "42.16.0",
+  "version": "42.17.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",

package/src/components/base/drawer/drawer.scss

@@ -1,5 +1,6 @@
 $gl-drawer-width: 400px;
 $gl-sidebar-width: 290px;
+$gl-drawer-scrim-gradient: linear-gradient(to bottom, $transparent-rgba, $white);
 
 .gl-drawer {
   @include gl-right-0;
@@ -61,6 +62,20 @@ $gl-sidebar-width: 290px;
   @include gl-py-5;
 }
 
+.gl-drawer-body-scrim-on-footer {
+  &::before {
+    background: $gl-drawer-scrim-gradient;
+    top: -$gl-border-size-1;
+    @include gl-translate-y-n100;
+    @include gl-content-empty;
+    @include gl-left-0;
+    @include gl-absolute;
+    @include gl-pointer-events-none;
+    @include gl-w-full;
+    @include gl-h-7;
+  }
+}
+
 .gl-drawer-footer-sticky {
   @include gl-bg-white;
   @include gl-bottom-0;
@@ -94,6 +109,18 @@ $gl-sidebar-width: 290px;
   @include gl-flex-grow-1;
 }
 
+.gl-drawer-body-scrim {
+  &::after {
+    background: $gl-drawer-scrim-gradient;
+    @include gl-content-empty;
+    @include gl-bottom-0;
+    @include gl-pointer-events-none;
+    @include gl-w-full;
+    @include gl-fixed;
+    @include gl-h-7;
+  }
+}
+
 .gl-drawer-body > * {
   @include gl-border-b-solid;
   @include gl-border-b-gray-100;

package/src/components/base/drawer/drawer.spec.js

@@ -101,6 +101,28 @@ describe('drawer component', () => {
     expect(wrapper.find(parentSelector).find(`[data-testid="${slot}"]`).exists()).toBe(true);
   });
 
+  it('should add scrim to footer', () => {
+    mountWithOpts({
+      slots: {
+        footer: `<div data-testid="footer" />`,
+      },
+    });
+
+    expect(wrapper.find('.gl-drawer-footer').classes()).toContain('gl-drawer-body-scrim-on-footer');
+    expect(wrapper.find('.gl-drawer-body').classes()).not.toContain('gl-drawer-body-scrim');
+  });
+
+  it('should add scrim to scrollable container', () => {
+    mountWithOpts({
+      slots: {
+        default: `<div data-testid="default" />`,
+      },
+    });
+
+    expect(wrapper.find('.gl-drawer-footer').exists()).toBe(false);
+    expect(wrapper.find('.gl-drawer-body').classes()).toContain('gl-drawer-body-scrim');
+  });
+
   it.each`
     variant      | variantClass
     ${'default'} | ${'gl-drawer-default'}

package/src/components/base/drawer/drawer.stories.js

@@ -1,8 +1,33 @@
-import { GlDrawer, GlButton } from '../../../index';
+import { GlDrawer, GlButton, GlMarkdown } from '../../../index';
 import { drawerVariants } from '../../../utils/constants';
 import readme from './drawer.md';
 
-const components = { GlDrawer, GlButton };
+const components = { GlDrawer, GlButton, GlMarkdown };
+
+const generateStaticContent = (number = 1) =>
+  Array.from(
+    Array(number),
+    (_, index) => `
+      <div class="gl-mb-8">
+        <h4 class="gl-mb-4">View jobs in a pipeline ${index}</h4>
+        <p>
+          Pipeline configuration begins with jobs. Jobs are the most fundamental element of a .gitlab-ci.yml file.
+        </p>
+        <p>Jobs are:</p>
+        <ul>
+          <li>Defined with constraints stating under what conditions they should be executed. </li>
+          <li>Top-level elements with an arbitrary name and must contain at least the script clause.</li>
+          <li>Not limited in how many can be defined.</li>
+        </ul>
+        <p>For example:</p>
+        <gl-markdown compact>
+          <code>job1: script: "execute-script-for-job1"</code>
+          <br />
+          <code>job2: script: "execute-script-for-job2"</code>
+        </gl-markdown>
+      </div>
+    `
+  ).join('');
 
 const generateDrawerContent = (items) =>
   items
@@ -145,6 +170,24 @@ export const WithStickyFooter = (_args, { viewMode }) => ({
 
 WithStickyFooter.args = generateProps();
 
+export const WithScrimAndStaticContent = (_args, { viewMode }) => ({
+  ...storyOptions(viewMode),
+  template: `
+    <div>
+      <gl-button @click="toggle">Toggle Drawer</gl-button>
+      ${createSidebarTemplate(`
+        <template #title>List Settings</template>
+        <div>
+          ${generateStaticContent(3)}
+        </div>
+      `)}
+    </div>`,
+});
+
+WithScrimAndStaticContent.args = generateProps({
+  headerSticky: true,
+});
+
 export const SidebarVariant = (_args, { viewMode }) => ({
   ...storyOptions(viewMode),
   template: `

package/src/components/base/drawer/drawer.vue

@@ -110,12 +110,13 @@ export default {
         </span>
         <slot name="header"></slot>
       </div>
-      <div class="gl-drawer-body">
+      <div class="gl-drawer-body" :class="{ 'gl-drawer-body-scrim': !shouldRenderFooter }">
         <slot></slot>
       </div>
       <div
         v-if="shouldRenderFooter"
         class="gl-drawer-footer gl-drawer-footer-sticky"
+        :class="{ 'gl-drawer-body-scrim-on-footer': shouldRenderFooter }"
         :style="{ zIndex }"
       >
         <slot name="footer"></slot>