@carto/kepler.gl 0.0.81 → 0.0.82

package/src/components/side-panel/panel-header.tsx

@@ -0,0 +1,386 @@
+// Copyright (c) 2022 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, {Component} from 'react';
+import styled from 'styled-components';
+import classnames from 'classnames';
+import {createSelector} from 'reselect';
+import {Tooltip} from 'components/common/styled-components';
+import KeplerGlLogo from 'components/common/logo';
+import {Save, DataTable, Save2, Picture, Db, Map as MapIcon, Share} from 'components/common/icons';
+import ClickOutsideCloseDropdown from 'components/side-panel/panel-dropdown';
+import Toolbar from 'components/common/toolbar';
+import ToolbarItem, {ToolbarItemProps} from 'components/common/toolbar-item';
+import {FormattedMessage} from 'localization';
+import {UiState} from 'reducers';
+import {BaseProps} from 'components/common/icons/base';
+
+type StyledPanelActionProps = {
+  active?: boolean;
+};
+
+type ActionItem = {
+  id: string;
+  label?: string;
+  blank?: boolean;
+  href?: string;
+  tooltip?: string;
+  iconComponent: React.ComponentType<Partial<BaseProps>>;
+  iconComponentProps?: BaseProps;
+  dropdownComponent?: React.ComponentType<DropdownComponentProps>;
+  onClick?: (p: PanelHeaderProps) => void;
+};
+
+type PanelActionProps = {
+  item: ActionItem;
+  onClick: () => void;
+};
+
+type PanelHeaderDropdownProps = {
+  id: string;
+  items: ToolbarItemProps[];
+  show?: boolean;
+  onClose: () => void;
+};
+
+type DropdownCallbacks = {
+  logoComponent?: React.ComponentType<{
+    appName: string;
+    appWebsite: string;
+    version: string;
+  }>;
+  onExportImage: () => void;
+  onExportData: () => void;
+  onExportConfig?: () => void;
+  onExportMap: () => void;
+  onSaveToStorage: (() => void) | null;
+  onSaveAsToStorage: (() => void) | null;
+  onSaveMap?: () => void;
+  onShareMap: (() => void) | null;
+};
+
+type Item = {
+  label: string;
+  icon: React.ComponentType<Partial<BaseProps>>;
+  key: string;
+  onClick: (p: DropdownComponentProps) => (() => void) | null;
+};
+
+type DropdownComponentProps = {
+  show: boolean;
+  onClose: () => void;
+  items?: Item[];
+} & DropdownCallbacks;
+
+type PanelHeaderProps = {
+  appName: string;
+  appWebsite: string;
+  version: string;
+  visibleDropdown: UiState['visibleDropdown'];
+  actionItems?: ActionItem[];
+  showExportDropdown: (i: string) => void;
+  hideExportDropdown: () => void;
+} & DropdownCallbacks;
+
+const StyledPanelHeader = styled.div.attrs(props => ({
+  className: classnames('side-side-panel__header', props.className)
+}))`
+  background-color: ${props => props.theme.sidePanelHeaderBg};
+  padding: 12px 16px 0 16px;
+`;
+
+const StyledPanelHeaderTop = styled.div.attrs(props => ({
+  className: classnames('side-panel__header__top', props.className)
+}))`
+  display: flex;
+  justify-content: space-between;
+  margin-bottom: 16px;
+  width: 100%;
+`;
+
+const StyledPanelTopActions = styled.div.attrs({
+  className: 'side-panel__top__actions'
+})`
+  display: flex;
+`;
+
+const StyledPanelAction = styled.div.attrs({
+  className: 'side-panel__panel-header__action'
+})<StyledPanelActionProps>`
+  align-items: center;
+  border-radius: 2px;
+  color: ${props => (props.active ? props.theme.textColorHl : props.theme.subtextColor)};
+  display: flex;
+  height: 26px;
+  justify-content: space-between;
+  margin-left: 4px;
+  padding: 5px;
+  font-weight: bold;
+  p {
+    display: inline-block;
+    margin-right: 6px;
+  }
+  a {
+    height: 20px;
+  }
+
+  :hover {
+    cursor: pointer;
+    color: ${props => props.theme.textColorHl};
+
+    a {
+      color: ${props => props.theme.textColorHl};
+    }
+  }
+`;
+
+const StyledToolbar = styled(Toolbar)`
+  position: absolute;
+`;
+
+export const PanelAction: React.FC<PanelActionProps> = ({item, onClick}) => (
+  <StyledPanelAction data-tip data-for={`${item.id}-action`} onClick={onClick}>
+    {item.label ? <p>{item.label}</p> : null}
+    <a target={item.blank ? '_blank' : ''} href={item.href} rel="noreferrer">
+      <item.iconComponent height="20px" {...item.iconComponentProps} />
+    </a>
+    {item.tooltip ? (
+      <Tooltip id={`${item.id}-action`} place="bottom" delayShow={500} effect="solid">
+        <FormattedMessage id={item.tooltip} />
+      </Tooltip>
+    ) : null}
+  </StyledPanelAction>
+);
+
+export const PanelHeaderDropdownFactory = () => {
+  const PanelHeaderDropdown: React.FC<PanelHeaderDropdownProps> = ({items, show, onClose, id}) => {
+    return (
+      <StyledToolbar show={show} className={`${id}-dropdown`}>
+        <ClickOutsideCloseDropdown
+          className="panel-header-dropdown__inner"
+          show={show}
+          onClose={onClose}
+        >
+          {items.map(item => (
+            <ToolbarItem
+              id={item.key}
+              key={item.key}
+              label={item.label}
+              icon={item.icon}
+              onClick={item.onClick}
+              onClose={onClose}
+            />
+          ))}
+        </ClickOutsideCloseDropdown>
+      </StyledToolbar>
+    );
+  };
+
+  return PanelHeaderDropdown;
+};
+
+const getDropdownItemsSelector = () =>
+  createSelector(
+    (props: DropdownComponentProps) => props,
+    props =>
+      (props.items || [])
+        .map(t => ({
+          ...t,
+          onClick: t.onClick && t.onClick(props) ? t.onClick(props) : null
+        }))
+        .filter(l => l.onClick)
+  );
+
+export const SaveExportDropdownFactory = (
+  PanelHeaderDropdown: ReturnType<typeof PanelHeaderDropdownFactory>
+) => {
+  const dropdownItemsSelector = getDropdownItemsSelector();
+
+  const SaveExportDropdown: React.FC<DropdownComponentProps> = props => (
+    <PanelHeaderDropdown
+      items={dropdownItemsSelector(props)}
+      show={props.show}
+      onClose={props.onClose}
+      id="save-export"
+    />
+  );
+
+  SaveExportDropdown.defaultProps = {
+    items: [
+      {
+        label: 'toolbar.exportImage',
+        icon: Picture,
+        key: 'image',
+        onClick: props => props.onExportImage
+      },
+      {
+        label: 'toolbar.exportData',
+        icon: DataTable,
+        key: 'data',
+        onClick: props => props.onExportData
+      },
+      {
+        label: 'toolbar.exportMap',
+        icon: MapIcon,
+        key: 'map',
+        onClick: props => props.onExportMap
+      },
+      {
+        label: 'toolbar.saveMap',
+        icon: Save2,
+        key: 'save',
+        onClick: props => props.onSaveMap!
+      },
+      {
+        label: 'toolbar.shareMapURL',
+        icon: Share,
+        key: 'share',
+        onClick: props => props.onShareMap
+      }
+    ]
+  };
+
+  return SaveExportDropdown;
+};
+SaveExportDropdownFactory.deps = [PanelHeaderDropdownFactory];
+
+export const CloudStorageDropdownFactory = (
+  PanelHeaderDropdown: ReturnType<typeof PanelHeaderDropdownFactory>
+) => {
+  const dropdownItemsSelector = getDropdownItemsSelector();
+
+  const CloudStorageDropdown: React.FC<DropdownComponentProps> = props => (
+    <PanelHeaderDropdown
+      items={dropdownItemsSelector(props)}
+      show={props.show}
+      onClose={props.onClose}
+      id="cloud-storage"
+    />
+  );
+  CloudStorageDropdown.defaultProps = {
+    items: [
+      {
+        label: 'Save',
+        icon: Save2,
+        key: 'save',
+        onClick: props => props.onSaveToStorage
+      },
+      {
+        label: 'Save As',
+        icon: Save2,
+        key: 'saveAs',
+        onClick: props => props.onSaveAsToStorage
+      }
+    ]
+  };
+  return CloudStorageDropdown;
+};
+CloudStorageDropdownFactory.deps = [PanelHeaderDropdownFactory];
+
+PanelHeaderFactory.deps = [SaveExportDropdownFactory, CloudStorageDropdownFactory];
+
+function PanelHeaderFactory(
+  SaveExportDropdown: ReturnType<typeof SaveExportDropdownFactory>,
+  CloudStorageDropdown: ReturnType<typeof CloudStorageDropdownFactory>
+): React.ComponentType<PanelHeaderProps> {
+  return class PanelHeader extends Component<PanelHeaderProps> {
+    static defaultProps = {
+      logoComponent: KeplerGlLogo,
+      actionItems: [
+        {
+          id: 'storage',
+          iconComponent: Db,
+          tooltip: 'tooltip.cloudStorage',
+          onClick: () => {},
+          dropdownComponent: CloudStorageDropdown
+        },
+        {
+          id: 'save',
+          iconComponent: Save,
+          onClick: () => {},
+          label: 'Share',
+          dropdownComponent: SaveExportDropdown
+        }
+      ]
+    };
+
+    render() {
+      const {
+        appName,
+        appWebsite,
+        version,
+        actionItems,
+        visibleDropdown,
+        showExportDropdown,
+        hideExportDropdown,
+        ...dropdownCallbacks
+      } = this.props;
+      let items = actionItems || [];
+
+      // don't render cloud storage icon if onSaveToStorage is not provided
+      if (typeof this.props.onSaveToStorage !== 'function') {
+        items = items.filter(ai => ai.id !== 'storage');
+      }
+
+      return (
+        <StyledPanelHeader className="side-panel__panel-header">
+          <StyledPanelHeaderTop className="side-panel__panel-header__top">
+            {this.props.logoComponent && (
+              <this.props.logoComponent
+                appName={appName}
+                version={version}
+                appWebsite={appWebsite}
+              />
+            )}
+            <StyledPanelTopActions>
+              {items.map(item => (
+                <div
+                  className="side-panel__panel-header__right"
+                  key={item.id}
+                  style={{position: 'relative'}}
+                >
+                  <PanelAction
+                    item={item}
+                    onClick={() => {
+                      if (item.dropdownComponent) {
+                        showExportDropdown(item.id);
+                      } else {
+                        item.onClick && item.onClick(this.props);
+                      }
+                    }}
+                  />
+                  {item.dropdownComponent ? (
+                    <item.dropdownComponent
+                      onClose={hideExportDropdown}
+                      show={visibleDropdown === item.id}
+                      {...dropdownCallbacks}
+                    />
+                  ) : null}
+                </div>
+              ))}
+            </StyledPanelTopActions>
+          </StyledPanelHeaderTop>
+        </StyledPanelHeader>
+      );
+    }
+  };
+}
+
+export default PanelHeaderFactory;

package/src/components/side-panel/panel-tab.tsx

@@ -0,0 +1,79 @@
+// Copyright (c) 2022 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 from 'react';
+import styled from 'styled-components';
+import {Tooltip} from 'components/common/styled-components';
+import {FormattedMessage} from 'localization';
+import {BaseProps} from 'components/common/icons/base';
+
+type StyledPanelTabProps = {
+  active?: boolean;
+};
+
+export type PanelItem = {
+  id: string;
+  label: string;
+  iconComponent: React.ComponentType<Partial<BaseProps>>;
+};
+
+type PanelTabProps = {
+  isActive: boolean;
+  panel: PanelItem;
+  onClick: () => void;
+};
+
+export const StyledPanelTab = styled.div.attrs({
+  className: 'side-panel__tab'
+})<StyledPanelTabProps>`
+  align-items: flex-end;
+  border-bottom-style: solid;
+  border-bottom-width: 2px;
+  border-bottom-color: ${props =>
+    props.active ? props.theme.panelToggleBorderColor : 'transparent'};
+  color: ${props => (props.active ? props.theme.subtextColorActive : props.theme.panelTabColor)};
+  display: flex;
+  justify-content: center;
+  margin-right: ${props => props.theme.panelToggleMarginRight}px;
+  padding-bottom: ${props => props.theme.panelToggleBottomPadding}px;
+  width: ${props => props.theme.panelTabWidth};
+
+  :hover {
+    cursor: pointer;
+    color: ${props => props.theme.textColorHl};
+  }
+`;
+
+export function PanelTabFactory() {
+  const PanelTab: React.FC<PanelTabProps> = ({isActive, onClick, panel}) => (
+    <StyledPanelTab data-tip data-for={`${panel.id}-nav`} active={isActive} onClick={onClick}>
+      <panel.iconComponent height="20px" />
+      <Tooltip id={`${panel.id}-nav`} effect="solid" delayShow={500} place="bottom">
+        <span>
+          <FormattedMessage id={panel.label || panel.id} />
+        </span>
+      </Tooltip>
+    </StyledPanelTab>
+  );
+
+  return PanelTab;
+}
+
+export default PanelTabFactory;

package/src/components/side-panel/panel-title.tsx

@@ -0,0 +1,35 @@
+// Copyright (c) 2022 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 styled from 'styled-components';
+import classnames from 'classnames';
+
+const PanelTitleFactory = () => styled.div.attrs(props => ({
+  className: classnames('panel-title', props.className)
+}))`
+  color: ${props => props.theme.titleTextColor};
+  font-size: ${props => props.theme.sidePanelTitleFontsize};
+  line-height: ${props => props.theme.sidePanelTitleLineHeight};
+  font-weight: 400;
+  letter-spacing: 1.25px;
+  margin-bottom: 14px;
+`;
+
+export default PanelTitleFactory;

package/src/components/side-panel/panel-toggle.tsx

@@ -0,0 +1,72 @@
+// Copyright (c) 2022 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 from 'styled-components';
+import PanelTabFactory, {PanelItem} from './panel-tab';
+import {toggleSidePanel} from 'actions/ui-state-actions';
+import {ActionHandler} from 'actions';
+
+type PanelToggleProps = {
+  panels: PanelItem[];
+  activePanel: string;
+  togglePanel: ActionHandler<typeof toggleSidePanel>;
+};
+
+const PanelHeaderBottom = styled.div.attrs({
+  className: 'side-side-panel__header__bottom'
+})`
+  background-color: ${props => props.theme.sidePanelHeaderBg};
+  border-bottom: 1px solid ${props => props.theme.sidePanelHeaderBorder};
+  padding: 0 16px;
+  display: flex;
+  min-height: 30px;
+`;
+
+PanelToggleFactory.deps = [PanelTabFactory];
+
+function PanelToggleFactory(PanelTab: ReturnType<typeof PanelTabFactory>) {
+  const PanelToggle: React.FC<PanelToggleProps> = ({activePanel, panels, togglePanel}) => {
+    const onClick = useCallback(
+      panel => {
+        const callback = panel.onClick || togglePanel;
+        callback(panel.id);
+      },
+      [togglePanel]
+    );
+
+    return (
+      <PanelHeaderBottom>
+        {panels.map(panel => (
+          <PanelTab
+            key={panel.id}
+            panel={panel}
+            isActive={activePanel === panel.id}
+            onClick={() => onClick(panel)}
+          />
+        ))}
+      </PanelHeaderBottom>
+    );
+  };
+
+  return PanelToggle;
+}
+
+export default PanelToggleFactory;