@skyscanner/backpack-web 0.0.1

package/bpk-component-description-list/src/BpkDescriptionTerm.js

@@ -0,0 +1,21 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import buildComponent from './ComponentFactory';
+
+export default buildComponent('dt', 'bpk-description-list__term');

package/bpk-component-description-list/src/ComponentFactory.js

@@ -0,0 +1,54 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import PropTypes from 'prop-types';
+import React from 'react';
+import { cssModules } from 'bpk-react-utils';
+
+import STYLES from './BpkDescriptionList.module.scss';
+
+const getClassName = cssModules(STYLES);
+
+const buildComponent = (TagName, baseClassName) => {
+  const Component = ({ children, className, ...rest }) => {
+    const classNames = [getClassName(baseClassName)];
+
+    if (className) {
+      classNames.push(className);
+    }
+
+    return (
+      <TagName className={classNames.join(' ')} {...rest}>
+        {children}
+      </TagName>
+    );
+  };
+
+  Component.propTypes = {
+    children: PropTypes.node.isRequired,
+    className: PropTypes.string,
+  };
+
+  Component.defaultProps = {
+    className: null,
+  };
+
+  return Component;
+};
+
+export default buildComponent;

package/bpk-component-dialog/README.md

@@ -0,0 +1,105 @@
+# bpk-component-dialog
+
+> Backpack dialog component.
+
+## Installation
+
+```sh
+npm install bpk-component-dialog --save-dev
+```
+
+## Usage
+
+```js
+import React, { Component } from 'react';
+import BpkDialog from 'bpk-component-dialog';
+import BpkButton from 'bpk-component-button';
+
+class App extends Component {
+  constructor() {
+    super();
+
+    this.state = {
+      isOpen: false,
+    };
+  }
+
+  onOpen = () => {
+    this.setState({
+      isOpen: true,
+    });
+  };
+
+  onClose = () => {
+    this.setState({
+      isOpen: false,
+    });
+  };
+
+  render() {
+    return (
+      <div id="dialog-container">
+        <div id="pagewrap">
+          <BpkButton onClick={this.onOpen}>Open dialog</BpkButton>
+        </div>
+        <BpkDialog
+          ariaLabel="example dialog to showcase component"
+          closeLabel="Close dialog"
+          id="my-dialog"
+          className="my-classname"
+          isOpen={this.state.isOpen}
+          onClose={this.onClose}
+          getApplicationElement={() => document.getElementById('pagewrap')}
+          renderTarget={() => document.getElementById('dialog-container')}
+        >
+          This is a dialog. You can put anything you want in here.
+        </BpkDialog>
+      </div>
+    );
+  }
+}
+```
+
+> **Note:** In order to "hide" your application from screen readers whilst the dialog is open you need to let it know what
+> the root element for your application is by returning it's DOM node via the function passed to the
+> `getApplicationElement` prop (see the example above). The `pagewrap` element id is a convention we use internally at Skyscanner. In most cases it should "just work".
+
+## Props
+
+| Property              | PropType | Required | Default Value    |
+| --------------------- | -------- | -------- | ---------------- |
+| ariaLabel             | string   | true     | -                |
+| children              | node     | true     | -                |
+| getApplicationElement | func     | true     | -                |
+| id                    | string   | true     | -                |
+| isOpen                | bool     | true     | -                |
+| className             | string   | false    | null             |
+| closeLabel            | string   | false    | null             |
+| dismissible           | bool     | false    | true             |
+| flare                 | bool     | false    | false            |
+| flareClassName        | string   | false    | null             |
+| headerIcon            | node     | false    | null             |
+| headerIconType        | oneOf(HEADER_ICON_TYPES.primary, HEADER_ICON_TYPES.warning, HEADER_ICON_TYPES.destructive) | false    | HEADER_ICON_TYPES.primary |
+| onClose               | func     | false    | See prop details |
+| renderTarget          | func     | false    | null             |
+
+### Prop Details
+
+#### onClose
+
+This is required unless `dismissible` is false.
+
+#### flareClassName
+
+This will change the style of the default flare view. Should you wish to apply an image to the flare you would pass the image using the CSS property `background-image`.
+
+#### getApplicationElement
+
+This is a function that should return the DOM node of the root of your application, the node returned will be hidden from screen readers when the dialog is displayed. Be careful to return the correct node from this, as on iPhone this element is actually hidden from view also.
+
+## Theme Props
+
+- `linkColor`
+- `linkHoverColor`
+- `linkActiveColor`
+- `linkVisitedColor`

package/bpk-component-dialog/examples.js

@@ -0,0 +1,182 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* @flow strict */
+
+import PropTypes from 'prop-types';
+import React, { Component, type Node } from 'react';
+import BpkText from 'bpk-component-text';
+import BpkButton from 'bpk-component-button';
+import TickIcon from 'bpk-component-icon/lg/tick';
+import InfoIcon from 'bpk-component-icon/lg/information-circle';
+import TrashIcon from 'bpk-component-icon/lg/trash';
+import { cssModules, withDefaultProps } from 'bpk-react-utils';
+
+import STYLES from './examples.module.scss';
+
+import BpkDialog, { HEADER_ICON_TYPES } from './index';
+
+const getClassName = cssModules(STYLES);
+
+const Paragraph = withDefaultProps(BpkText, {
+  textStyle: 'base',
+  tagName: 'p',
+  className: getClassName('bpk-dialog-paragraph'),
+});
+
+type Props = {
+  children: Node,
+  dismissible: boolean,
+  headerIcon: ?Node,
+};
+
+type State = {
+  isOpen: boolean,
+};
+
+class DialogContainer extends Component<Props, State> {
+  static propTypes = {
+    children: PropTypes.node.isRequired,
+    dismissible: PropTypes.bool,
+  };
+
+  static defaultProps = {
+    dismissible: true,
+    headerIcon: null,
+  };
+
+  constructor() {
+    super();
+
+    this.state = {
+      isOpen: false,
+    };
+  }
+
+  onOpen = () => {
+    this.setState({
+      isOpen: true,
+    });
+  };
+
+  onClose = () => {
+    this.setState({
+      isOpen: false,
+    });
+  };
+
+  render() {
+    return (
+      <div id="dialog-container">
+        <div id="pagewrap">
+          <BpkButton onClick={this.onOpen}>Open dialog</BpkButton>
+        </div>
+        {/* $FlowFixMe[cannot-spread-inexact] - inexact rest. See 'decisions/flowfixme.md'. */}
+        <BpkDialog
+          closeLabel="Close dialog"
+          id="my-dialog"
+          ariaLabel="example dialog to showcase component"
+          className="my-classname"
+          isOpen={this.state.isOpen}
+          onClose={this.onClose}
+          getApplicationElement={() => document.getElementById('pagewrap')}
+          renderTarget={() => document.getElementById('dialog-container')}
+          headerIcon
+          {...this.props}
+        >
+          {this.props.children}
+          <BpkButton onClick={this.onClose}>Close</BpkButton>
+        </BpkDialog>
+      </div>
+    );
+  }
+}
+
+const DefaultExample = () => (
+  <DialogContainer>
+    <Paragraph>
+      This is a default dialog. You can put anything you want in here.
+    </Paragraph>
+  </DialogContainer>
+);
+
+const WithIconExample = () => (
+  <div>
+    <div>
+      <span>Default Icon Dialog</span>
+      <DialogContainer headerIcon={<TickIcon />} dismissible={false}>
+        <Paragraph>
+          This is a default dialog with an icon. You can put anything you want
+          in here.
+        </Paragraph>
+      </DialogContainer>
+    </div>
+    <br />
+    <div>
+      <span>Warning Icon Dialog</span>
+      <DialogContainer
+        headerIcon={<InfoIcon />}
+        headerIconType={HEADER_ICON_TYPES.warning}
+        dismissible={false}
+      >
+        <Paragraph>
+          This is a warning dialog with an icon. You can put anything you want
+          in here.
+        </Paragraph>
+      </DialogContainer>
+    </div>
+    <br />
+    <div>
+      <span>Destructive Icon Dialog</span>
+      <DialogContainer
+        headerIcon={<TrashIcon />}
+        headerIconType={HEADER_ICON_TYPES.destructive}
+        dismissible={false}
+      >
+        <Paragraph>
+          This is a destructive dialog with an icon. You can put anything you
+          want in here.
+        </Paragraph>
+      </DialogContainer>
+    </div>
+  </div>
+);
+
+const NotDismissibleExample = () => (
+  <DialogContainer dismissible={false}>
+    <Paragraph>
+      This is not dismissible. To close it you must bind the `onClose` function
+      to a component inside the dialog, like the button below.
+    </Paragraph>
+  </DialogContainer>
+);
+
+const WithFlareExample = () => (
+  <DialogContainer flare dismissible={false}>
+    <Paragraph>
+      This is a dialog with a flare view added as the header.
+    </Paragraph>
+  </DialogContainer>
+);
+
+export {
+  DefaultExample,
+  WithIconExample,
+  NotDismissibleExample,
+  WithFlareExample,
+};

package/bpk-component-dialog/examples.module.css

@@ -0,0 +1,18 @@
+/*
+ * Backpack - Skyscanner's Design System
+ * 
+ * Copyright 2016 Skyscanner Ltd
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/
+@keyframes bpk-keyframe-spin{100%{transform:rotate(1turn)}}.bpk-dialog-paragraph{margin-bottom:0.5rem}

package/bpk-component-dialog/examples.module.scss

@@ -0,0 +1,25 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+@import '~bpk-mixins';
+
+$bpk-spacing-v2: true;
+
+.bpk-dialog-paragraph {
+  margin-bottom: bpk-spacing-md();
+}

package/bpk-component-dialog/index.js

@@ -0,0 +1,26 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* @flow strict */
+
+import BpkDialog from './src/BpkDialog';
+import { HEADER_ICON_TYPES, type Props } from './src/common-types';
+
+export type BpkDialogProps = Props;
+export default BpkDialog;
+export { HEADER_ICON_TYPES };

package/bpk-component-dialog/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "bpk-component-dialog",
+  "version": "4.1.0",
+  "description": "Backpack dialog component.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:Skyscanner/backpack.git"
+  },
+  "author": "Backpack Design System <backpack@skyscanner.net>",
+  "main": "index.js",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "gitHead": "f9f94f86d7cfc75e43bc6ad5eb01b23e62a89cc8",
+  "dependencies": {
+    "bpk-component-close-button": "^3.1.0",
+    "bpk-component-flare": "^2.1.0",
+    "bpk-mixins": "^26.1.0",
+    "bpk-react-utils": "^4.1.0",
+    "bpk-scrim-utils": "^5.1.0",
+    "prop-types": "^15.7.2"
+  },
+  "peerDependencies": {
+    "react": "^16.3.0 || ^17.0.0"
+  },
+  "devDependencies": {
+    "bpk-component-button": "^5.1.0",
+    "bpk-component-icon": "^9.2.0",
+    "bpk-component-text": "^6.1.0"
+  }
+}

package/bpk-component-dialog/src/BpkDialog.js

@@ -0,0 +1,89 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* @flow strict */
+
+import React from 'react';
+import { cssModules, Portal } from 'bpk-react-utils';
+import BpkCloseButton from 'bpk-component-close-button';
+
+import BpkDialogInner from './BpkDialogInner';
+import { type Props, propTypes, defaultProps } from './common-types';
+import STYLES from './BpkDialog.module.scss';
+
+const getClassName = cssModules(STYLES);
+
+const BpkDialog = (props: Props) => {
+  const {
+    children,
+    closeLabel,
+    dismissible,
+    headerIcon,
+    headerIconType,
+    isOpen,
+    onClose,
+    renderTarget,
+    ...rest
+  } = props;
+
+  const headerIconClassNames = getClassName(
+    'bpk-dialog__icon',
+    `bpk-dialog__icon--${headerIconType}`,
+  );
+  const closeButtonClassNames = getClassName('bpk-dialog__close-button');
+
+  return (
+    <Portal
+      isOpen={isOpen}
+      onClose={onClose}
+      renderTarget={renderTarget}
+      closeOnEscPressed={dismissible}
+    >
+      {/* $FlowFixMe[cannot-spread-inexact] - inexact rest. See 'decisions/flowfixme.md'. */}
+      <BpkDialogInner
+        onClose={onClose}
+        closeOnScrimClick={dismissible}
+        containerClassName={getClassName('bpk-dialog__container')}
+        contentClassName={
+          headerIcon ? getClassName('bpk-dialog--with-icon') : null
+        }
+        {...rest}
+      >
+        {headerIcon && <div className={headerIconClassNames}>{headerIcon}</div>}
+        {dismissible && (
+          <BpkCloseButton
+            className={closeButtonClassNames}
+            label={closeLabel}
+            onClick={onClose}
+          />
+        )}
+        {children}
+      </BpkDialogInner>
+    </Portal>
+  );
+};
+
+BpkDialog.propTypes = {
+  ...propTypes,
+};
+
+BpkDialog.defaultProps = {
+  ...defaultProps,
+};
+
+export default BpkDialog;

package/bpk-component-dialog/src/BpkDialog.module.css

@@ -0,0 +1,18 @@
+/*
+ * Backpack - Skyscanner's Design System
+ * 
+ * Copyright 2016 Skyscanner Ltd
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/
+@keyframes bpk-keyframe-spin{100%{transform:rotate(1turn)}}.bpk-dialog__container{display:flex;padding:1.5rem}@media screen\0 {.bpk-dialog__container{display:block}}.bpk-dialog__close-button{float:right;margin:0 0 1rem 1rem}html[dir='rtl'] .bpk-dialog__close-button{float:left;margin:0 1rem 1rem 0}.bpk-dialog--with-icon{margin-top:2rem}.bpk-dialog__icon{position:absolute;top:0;left:50%;display:flex;width:3.5rem;height:3.5rem;margin-top:-1.75rem;margin-left:-1.75rem;justify-content:center;align-items:center;border:2px #fff solid;border-radius:50%}.bpk-dialog__icon--primary{background-color:#00a698}.bpk-dialog__icon--warning{background-color:#ff9400}.bpk-dialog__icon--destructive{background-color:#d1435b}.bpk-dialog__icon>svg{fill:#fff}

package/bpk-component-dialog/src/BpkDialog.module.scss

@@ -0,0 +1,80 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+@import '~bpk-mixins/index';
+
+$bpk-spacing-v2: true;
+
+.bpk-dialog {
+  &__container {
+    display: flex;
+    padding: bpk-spacing-lg();
+
+    // IE11 and below hack for buggy flexbox support
+    @media screen\0 {
+      display: block;
+    }
+  }
+
+  &__close-button {
+    float: right;
+    margin: 0 0 bpk-spacing-base() bpk-spacing-base();
+
+    @include bpk-rtl {
+      float: left;
+      margin: 0 bpk-spacing-base() bpk-spacing-base() 0;
+    }
+  }
+
+  &--with-icon {
+    margin-top: bpk-spacing-xl();
+  }
+
+  &__icon {
+    $size: bpk-spacing-md() * 7;
+
+    position: absolute;
+    top: 0;
+    left: 50%;
+    display: flex;
+    width: $size;
+    height: $size;
+    margin-top: -$size / 2;
+    margin-left: -$size / 2;
+    justify-content: center;
+    align-items: center;
+    border: $bpk-border-size-lg $bpk-color-white solid;
+    border-radius: 50%;
+
+    &--primary {
+      background-color: $bpk-color-monteverde;
+    }
+
+    &--warning {
+      background-color: $bpk-color-kolkata;
+    }
+
+    &--destructive {
+      background-color: $bpk-color-panjin;
+    }
+
+    > svg {
+      fill: $bpk-color-white;
+    }
+  }
+}