build sheet component

Shopify · May 3, 2019 · b59c396 · b59c396
1 parent 68e55bb
commit b59c396
Show file tree

Hide file tree

Showing 10 changed files with 634 additions and 3 deletions.
diff --git a/UNRELEASED.md b/UNRELEASED.md
@@ -12,6 +12,8 @@ Use [the changelog guidelines](https://git.io/polaris-changelog-guidelines) to f
 
 ### New components
 
+- Added the `Sheet` component ([#1250](https://github.com/Shopify/polaris-react/pull/1250))
+
 ### Enhancements
 
 - Improved the performance of `ResourceList` ([#1313](https://github.com/Shopify/polaris-react/pull/1313))

diff --git a/src/components/Backdrop/Backdrop.scss b/src/components/Backdrop/Backdrop.scss
@@ -9,12 +9,16 @@ $backdrop-color: rgba(33, 43, 54, 0.4);
   bottom: 0;
   left: 0;
   display: block;
-  background: $backdrop-color;
+  background-color: $backdrop-color;
   animation: fade-in duration() $entry-iterations forwards;
   opacity: 1;
   will-change: opacity;
 }
 
+.transparent {
+  background-color: transparent;
+}
+
 .belowNavigation {
   z-index: z-index(nav-backdrop, $fixed-element-stacking-order);
 }

diff --git a/src/components/Backdrop/Backdrop.tsx b/src/components/Backdrop/Backdrop.tsx
@@ -5,17 +5,19 @@ import ScrollLock from '../ScrollLock';
 import styles from './Backdrop.scss';
 
 export interface Props {
+  belowNavigation?: boolean;
+  transparent?: boolean;
   onClick?(): void;
   onTouchStart?(): void;
-  belowNavigation?: boolean;
 }
 
 export default function Backdrop(props: Props) {
-  const {onClick, onTouchStart, belowNavigation} = props;
+  const {onClick, onTouchStart, belowNavigation, transparent} = props;
 
   const className = classNames(
     styles.Backdrop,
     belowNavigation && styles.belowNavigation,
+    transparent && styles.transparent,
   );
 
   return (

diff --git a/src/components/Sheet/README.md b/src/components/Sheet/README.md
@@ -0,0 +1,270 @@
+---
+name: Sheet
+category: Overlays
+platforms:
+  - web
+keywords:
+  - sheet
+---
+
+# Sheet
+
+A sheet is a large container that enters from the edge of the screen when triggered by the merchant. It’s used to provide merchants with actions and information contextual to the page. It doesn’t interrupt their flow like a modal.
+
+---
+
+## Required components
+
+The sheet component must be wrapped in the [frame](/components/structure/frame) component.
+
+---
+
+## Use in an embedded application
+
+Use of the sheet component in an embedded application is not currently supported. If this is a feature you would like to see supported by Shopify App Bridge, let us know in the [forums](https://community.shopify.com/c/Shopify-APIs-SDKs/bd-p/shopify-apis-and-technology).
+
+---
+
+## Accessibility
+
+Sheets provide an opportunity to let merchants dig into more detail on their current task, or access information for their current task in a different way. Although merchants may be able to see content in the sheet and the main page content at the same time, they should only be expected to interact with one or the other at any given time.
+
+### Keyboard support
+
+- Use the `onClose` prop so that the sheet can be closed with the <kbd>esc</kbd> key as well as with button-based controls
+- Use a button to open the sheet
+- When the sheet opens, move focus to it so merchants who rely on the keyboard and screen readers can access it
+- When the sheet closes, move focus back to the button that launched it
+
+---
+
+## Best practices
+
+The sheet component should:
+
+- Include a heading that summarizes the actions and information in the sheet, for example, More filters
+- Be openable through clear actions, like a link or button
+- Be close-able through clear actions, like Done, the [X] button, and the esc key
+- Include information and actions contextual to the current task
+- Not block merchants from completing their task, like a modal would
+- Not open from within another sheet (only one sheet can be open at a time)
+- Preserve its state—the settings and actions won’t reset when it’s closed
+
+The sheet component is best used in cases where the merchant needs to see elements behind it, and for that reason it uses a transparent backdrop. The backdrop is a full screen overlay which closes its parent component when pressed.
+
+---
+
+## Examples
+
+### Basic sheet
+
+<!-- example-for: web -->
+
+Use as the default option for a sheet.
+
+```jsx
+class SheetExample extends React.Component {
+  state = {
+    sheetActive: true,
+    title: 'Big yellow socks',
+    description:
+      "They're big, yellow socks. What more could you possibly want from socks? These socks will change your life.\n\nThey're made from light, hand-loomed cotton that's so soft, you'll feel like you are walking on a cloud.",
+    salesChannels: [
+      {value: 'onlineStore', label: 'Online Store'},
+      {value: 'facebook', label: 'Facebook'},
+      {value: 'googleShopping', label: 'Google shopping'},
+      {value: 'facebookMarketing', label: 'Facebook Marketing'},
+    ],
+    selected: [],
+  };
+
+  render() {
+    const {
+      state: {sheetActive, title, description, salesChannels, selected},
+      handleCloseSheet,
+      handleOpenSheet,
+      handleChange,
+      handleToggleSheet,
+      hasSelectedSalesChannels,
+      selectedSalesChannels,
+    } = this;
+
+    const theme = {
+      colors: {
+        topBar: {
+          background: '#357997',
+        },
+      },
+      logo: {
+        width: 124,
+        topBarSource:
+          'https://cdn.shopify.com/s/files/1/0446/6937/files/jaded-pixel-logo-color.svg?6215648040070010999',
+        contextualSaveBarSource:
+          'https://cdn.shopify.com/s/files/1/0446/6937/files/jaded-pixel-logo-gray.svg?6215648040070010999',
+        url: 'http://jadedpixel.com',
+        accessibilityLabel: 'Jaded Pixel',
+      },
+    };
+
+    const salesChannelsCardMarkup = hasSelectedSalesChannels ? (
+      <List>
+        {selectedSalesChannels.map((channel, index) => (
+          <List.Item key={index}>{channel}</List.Item>
+        ))}
+      </List>
+    ) : (
+      <div
+        style={{
+          alignItems: 'center',
+          display: 'flex',
+          justifyContent: 'space-between',
+          width: '100%',
+        }}
+      >
+        <p>No sales channels selected</p>
+        <Button onClick={handleToggleSheet}>Manage sales channels</Button>
+      </div>
+    );
+
+    const salesChannelAction = hasSelectedSalesChannels
+      ? [
+          {
+            onAction: handleOpenSheet,
+            content: 'Manage sales channels',
+          },
+        ]
+      : null;
+
+    return (
+      <AppProvider theme={theme}>
+        <Frame topBar={<TopBar />}>
+          <Page singleColumn title="Big yellow socks">
+            <Card sectioned>
+              <FormLayout>
+                <TextField
+                  label="Title"
+                  onChange={handleChange('title')}
+                  value={title}
+                  readOnly
+                />
+                <TextField
+                  label="Description"
+                  onChange={handleChange('description')}
+                  value={description}
+                  multiline
+                  readOnly
+                />
+              </FormLayout>
+            </Card>
+            <Card
+              sectioned
+              subdued
+              title="Product availability"
+              actions={salesChannelAction}
+            >
+              {salesChannelsCardMarkup}
+            </Card>
+            <Sheet open={sheetActive} onClose={handleCloseSheet}>
+              <div
+                style={{
+                  display: 'flex',
+                  flexDirection: 'column',
+                  height: '100%',
+                }}
+              >
+                <div
+                  style={{
+                    alignItems: 'center',
+                    borderBottom: '1px solid #DFE3E8',
+                    display: 'flex',
+                    justifyContent: 'space-between',
+                    padding: '1.6rem',
+                    width: '100%',
+                  }}
+                >
+                  <Heading>Manage sales channels</Heading>
+                  <Button
+                    accessibilityLabel="Cancel"
+                    icon="cancel"
+                    onClick={handleCloseSheet}
+                    plain
+                  />
+                </div>
+                <Scrollable style={{padding: '1.6rem', height: '100%'}}>
+                  <ChoiceList
+                    choices={salesChannels}
+                    selected={selected}
+                    allowMultiple
+                    onChange={handleChange('selected')}
+                  />
+                </Scrollable>
+                <div
+                  style={{
+                    alignItems: 'center',
+                    borderTop: '1px solid #DFE3E8',
+                    display: 'flex',
+                    justifyContent: 'space-between',
+                    padding: '1.6rem',
+                    width: '100%',
+                  }}
+                >
+                  <Button onClick={handleCloseSheet}>Cancel</Button>
+                  <Button primary onClick={handleCloseSheet}>
+                    Done
+                  </Button>
+                </div>
+              </div>
+            </Sheet>
+          </Page>
+        </Frame>
+      </AppProvider>
+    );
+  }
+
+  handleOpenSheet = () => {
+    this.setState({sheetActive: true});
+  };
+
+  handleCloseSheet = () => {
+    this.setState({sheetActive: false});
+  };
+
+  handleToggleSheet = () => {
+    const {
+      state: {sheetActive},
+      handleCloseSheet,
+      handleOpenSheet,
+    } = this;
+
+    sheetActive ? handleCloseSheet() : handleOpenSheet();
+  };
+
+  handleChange = (field) => {
+    return (value) => this.setState({[field]: value});
+  };
+
+  get hasSelectedSalesChannels() {
+    return this.selectedSalesChannels.length > 0;
+  }
+
+  get selectedSalesChannels() {
+    const {salesChannels, selected} = this.state;
+
+    const salesChannelsObj = salesChannels.reduce((accumulator, current) => {
+      accumulator[current.value] = current.label;
+      return accumulator;
+    }, {});
+
+    return selected.map((element) => {
+      return salesChannelsObj[element];
+    });
+  }
+}
+```
+
+---
+
+## Related components
+
+- To offer an action before merchants can go to the next step in the flow, use the [modal component](/components/overlays/modal).
+- To present a small amount of content or a menu of actions in a non-blocking overlay, use the [popover component](/components/overlays/popover).
diff --git a/src/components/Sheet/Sheet.scss b/src/components/Sheet/Sheet.scss
@@ -0,0 +1,73 @@
+$sheet-desktop-width: rem(380px);
+
+.Sheet {
+  position: fixed;
+  bottom: 0;
+  width: 100vw;
+  height: 100%;
+  background: color('white');
+  box-shadow: shadow('layer');
+
+  @media screen and (-ms-high-contrast: active) {
+    border-left: border();
+  }
+
+  &.desktop {
+    right: 0;
+    width: $sheet-desktop-width;
+  }
+
+  &:focus {
+    outline: 0;
+  }
+}
+
+.Container {
+  position: fixed;
+  z-index: z-index('modal', $fixed-element-stacking-order);
+  top: 0;
+  right: 0;
+  bottom: 0;
+  left: 0;
+
+  &.desktop {
+    left: auto;
+    width: $sheet-desktop-width;
+  }
+}
+
+.Bottom {
+  will-change: transform;
+  transition: transform duration('slow') easing('base');
+  transform-origin: bottom;
+}
+.enterBottom {
+  transform: translateY(100%);
+}
+.enterBottomActive {
+  transform: translateY(0%);
+}
+.exitBottom {
+  transform: translateY(0%);
+}
+.exitBottomActive {
+  transform: translateY(100%);
+}
+
+.Right {
+  will-change: transform;
+  transition: transform duration('slow') easing('base');
+  transform-origin: right;
+}
+.enterRight {
+  transform: translateX(100%);
+}
+.enterRightActive {
+  transform: translateX(0%);
+}
+.exitRight {
+  transform: translateX(0%);
+}
+.exitRightActive {
+  transform: translateX(100%);
+}