map-control-panel.tsx

// Copyright (c) 2023 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

import React, {useCallback} from 'react';
import styled, {StyledComponent} from 'styled-components';
import {FormattedMessage} from '@kepler.gl/localization';
import {CenterFlexbox, IconRoundSmall} from '../common/styled-components';
import {Close, Pin} from '../common/icons';
import Switch from '../common/switch';
import {MapState} from '@kepler.gl/types';
import {ActionHandler, toggleSplitMapViewport} from '@kepler.gl/actions';

const StyledMapControlPanel = styled.div`
  background-color: ${props => props.theme.mapPanelBackgroundColor};
  flex-grow: 1;
  z-index: 1;
  p {
    margin-bottom: 0;
  }
`;

const StyledMapControlPanelContent = styled.div.attrs({
  className: 'map-control__panel-content'
})`
  ${props => props.theme.dropdownScrollBar};
  max-height: 500px;
  min-height: 100px;
  min-width: ${props => props.theme.mapControl.width}px;
  overflow: overlay;
`;

const StyledMapControlPanelHeader = styled.div.attrs({
  className: 'map-control__panel-header'
})`
  display: flex;
  justify-content: space-between;
  background-color: ${props => props.theme.mapPanelHeaderBackgroundColor};
  height: 32px;
  padding: 6px 12px;
  font-family: ${props => props.theme.fontFamily};
  font-size: 11px;
  color: ${props => props.theme.titleTextColor};
  position: relative;
  box-sizing: border-box;

  button {
    width: 18px;
    height: 18px;
  }
`;

const StyledMapControlPanelHeaderSplitViewportsTools: StyledComponent<
  'div',
  any,
  {
    className: 'map-control__panel-split-viewport-tools';
  },
  'className'
> = styled(StyledMapControlPanelHeader).attrs({
  className: 'map-control__panel-split-viewport-tools'
})`
  display: flex;
  flex-direction: column;
  justify-content: space-between;
  align-items: self-start;
  height: unset;
`;

const StyledSBCenterFlexbox = styled(CenterFlexbox)`
  width: 100%;
  justify-content: space-between;
  flex-direction: row;
`;

interface StyledDisableableTextProps {
  disabled?: boolean;
}

const StyledDisableableText = styled.span<StyledDisableableTextProps>`
  opacity: ${props => (props.disabled ? 0.4 : 1)};
  pointer-events: ${props => (props.disabled ? 'none' : 'all')};
`;

const StyledDisableableSwitch = styled(Switch)`
  opacity: ${props => (props.disabled ? 0.4 : 1)};
  pointer-events: ${props => (props.disabled ? 'none' : 'all')};
`;

const StyledIcon = styled(IconRoundSmall)`
  color: ${props => props.theme.activeColor};
  background-color: transparent;

  :hover {
    cursor: pointer;
    background-color: transparent;
    color: ${props => props.theme.linkBtnColor};
  }
`;

export type MapControlPanelProps = {
  header?: string;
  scale?: number;
  onClick: React.MouseEventHandler<HTMLDivElement>;
  onPinClick?: React.MouseEventHandler<HTMLDivElement>;
  pinnable?: boolean;
  disableClose?: boolean;
  isExport?: boolean;
  logoComponent?: Element;
  mapState?: MapState;
  onToggleSplitMapViewport?: ActionHandler<typeof toggleSplitMapViewport>;
  isViewportUnsyncAllowed?: boolean;
};

function MapControlPanelFactory() {
  const MapControlPanel: React.FC<MapControlPanelProps> = React.memo(
    ({
      children,
      header,
      pinnable,
      disableClose,
      onPinClick,
      onClick,
      scale = 1,
      isExport,
      logoComponent,
      mapState,
      onToggleSplitMapViewport,
      isViewportUnsyncAllowed
    }) => {
      const {isViewportSynced, isZoomLocked} = mapState || {};
      const onUnlockViewportChange = useCallback(() => {
        onToggleSplitMapViewport?.({isViewportSynced: !isViewportSynced});
      }, [isViewportSynced, onToggleSplitMapViewport]);

      const onSyncZoomChange = useCallback(() => {
        onToggleSplitMapViewport?.({isZoomLocked: !isZoomLocked});
      }, [isZoomLocked, onToggleSplitMapViewport]);

      return (
        <StyledMapControlPanel
          className="map-control-panel"
          style={{
            transform: `scale(${scale})`,
            marginBottom: '8px !important'
          }}
        >
          {mapState?.isSplit && isViewportUnsyncAllowed ? (
            <StyledMapControlPanelHeaderSplitViewportsTools>
              <StyledSBCenterFlexbox style={{paddingBottom: '6px'}}>
                <FormattedMessage id="Unlock Viewport" />
                <StyledDisableableSwitch
                  checked={!mapState?.isViewportSynced}
                  id="unlock-viewport-toggle"
                  onChange={onUnlockViewportChange}
                />
              </StyledSBCenterFlexbox>
              <StyledSBCenterFlexbox>
                <StyledDisableableText disabled={mapState?.isViewportSynced}>
                  <FormattedMessage id="Sync Zoom" />
                </StyledDisableableText>
                <StyledDisableableSwitch
                  checked={mapState?.isZoomLocked}
                  id="sync-zoom-toggle"
                  onChange={onSyncZoomChange}
                  disabled={mapState?.isViewportSynced}
                />
              </StyledSBCenterFlexbox>
            </StyledMapControlPanelHeaderSplitViewportsTools>
          ) : null}

          <StyledMapControlPanelHeader>
            {isExport && logoComponent ? (
              logoComponent
            ) : header ? (
              <span style={{verticalAlign: 'middle'}}>
                <FormattedMessage id={header} />
              </span>
            ) : null}
            {isExport ? null : (
              <>
                {pinnable && (
                  <StyledIcon className="pin-map-control-item" onClick={onPinClick}>
                    <Pin height="16px" />
                  </StyledIcon>
                )}
                {disableClose ? null : (
                  <StyledIcon className="close-map-control-item" onClick={onClick}>
                    <Close height="16px" />
                  </StyledIcon>
                )}
              </>
            )}
          </StyledMapControlPanelHeader>
          <StyledMapControlPanelContent>{children}</StyledMapControlPanelContent>
        </StyledMapControlPanel>
      );
    }
  );

  MapControlPanel.displayName = 'MapControlPanel';

  return MapControlPanel;
}

export default MapControlPanelFactory;