BreakpointsPage.js

/*
 * Backpack - Skyscanner's Design System
 *
 * Copyright 2016-2019 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 React from 'react';
import PropTypes from 'prop-types';
import BpkBreakpoint, { BREAKPOINTS } from 'bpk-component-breakpoint';
import { cssModules } from 'bpk-react-utils';
import breakpointReadme from 'bpk-component-breakpoint/README.md';

import DocsPageBuilder from '../../components/DocsPageBuilder';
import DocsPageWrapper from '../../components/DocsPageWrapper';
import IntroBlurb from '../../components/IntroBlurb';

import STYLES from './breakpoints-page.scss';

const getClassName = cssModules(STYLES);

const MediaQueryStatus = props => {
  const className = getClassName(
    props.isActive
      ? 'bpk-breakpoints-demo--active'
      : 'bpk-breakpoints-demo--inactive',
  );

  return <div className={className}>{props.children}</div>;
};

MediaQueryStatus.propTypes = {
  isActive: PropTypes.bool.isRequired,
  children: PropTypes.node.isRequired,
};

const components = [
  {
    id: 'default',
    title: 'Default',
    examples: [
      <div className={getClassName('bpk-breakpoints-demo')}>
        <BpkBreakpoint query={BREAKPOINTS.MOBILE}>
          {isActive => (
            <MediaQueryStatus isActive={isActive}>MOBILE</MediaQueryStatus>
          )}
        </BpkBreakpoint>
        <BpkBreakpoint query={BREAKPOINTS.TABLET}>
          {isActive => (
            <MediaQueryStatus isActive={isActive}>TABLET</MediaQueryStatus>
          )}
        </BpkBreakpoint>
        <BpkBreakpoint query={BREAKPOINTS.TABLET_ONLY}>
          {isActive => (
            <MediaQueryStatus isActive={isActive}>TABLET ONLY</MediaQueryStatus>
          )}
        </BpkBreakpoint>
        <BpkBreakpoint query={BREAKPOINTS.ABOVE_MOBILE}>
          {isActive => (
            <MediaQueryStatus isActive={isActive}>
              ABOVE MOBILE
            </MediaQueryStatus>
          )}
        </BpkBreakpoint>
        <BpkBreakpoint query={BREAKPOINTS.ABOVE_TABLET}>
          {isActive => (
            <MediaQueryStatus isActive={isActive}>
              ABOVE TABLET
            </MediaQueryStatus>
          )}
        </BpkBreakpoint>
      </div>,
    ],
  },
];

const blurb = [
  <IntroBlurb>
    The breakpoint component allows information to be displayed in different
    ways depending on the screen size. To simplify things, Backpack uses only
    three breakpoints optimised for mobile, tablet and desktop viewports.
  </IntroBlurb>,
];

const BreakpointsSubPage = ({ ...rest }) => (
  <DocsPageBuilder
    title="Breakpoint"
    components={components}
    readme={breakpointReadme}
    sassdocId="breakpoints"
    {...rest}
  />
);

const BreakpointsPage = () => (
  <DocsPageWrapper
    title="Breakpoint"
    blurb={blurb}
    webSubpage={<BreakpointsSubPage wrapped />}
  />
);

export default BreakpointsPage;