passbolt-styleguide/src/react-extension/components/UserSetting/DisplayUserTheme/DisplayUserTheme.js

Passbolt styleguide contains common styling assets used by the different sites, plugin, etc.

/**
 * Passbolt ~ Open source password manager for teams
 * Copyright (c) 2020 Passbolt SA (https://www.passbolt.com)
 *
 * Licensed under GNU Affero General Public License version 3 of the or any later version.
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) 2020 Passbolt SA (https://www.passbolt.com)
 * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
 * @link          https://www.passbolt.com Passbolt(tm)
 * @since         2.13.0
 */

import React from "react";
import PropTypes from "prop-types";
import { withAppContext } from "../../../../shared/context/AppContext/AppContext";
import { withLoading } from "../../../contexts/LoadingContext";
import NotifyError from "../../Common/Error/NotifyError/NotifyError";
import { withDialog } from "../../../contexts/DialogContext";
import { withActionFeedback } from "../../../contexts/ActionFeedbackContext";
import { Trans, withTranslation } from "react-i18next";
import DefaultThemeSVG from "../../../../img/themes/default.svg";
import MidgarThemeSVG from "../../../../img/themes/midgar.svg";
import SolarizedLightThemeSVG from "../../../../img/themes/solarized_light.svg";
import SolarizedDarkThemeSVG from "../../../../img/themes/solarized_dark.svg";

/**
 * This component displays the user profile theme
 */
class DisplayUserTheme extends React.Component {
  /**
   * Default constructor
   * @param props Component props
   */
  constructor(props) {
    super(props);
    this.state = this.defaultState;
    this.bindHandlers();
  }

  /**
   * Returns the component default state
   */
  get defaultState() {
    return {
      themes: [], // The list of available theme
      selectedTheme: null, // The current user selected theme
    };
  }

  /**
   * Whenever the component is mounted
   * @returns {Promise<void>}
   */
  async componentDidMount() {
    await this.populate();
  }

  /**
   * Binds the component handlers
   */
  bindHandlers() {
    this.onSelectSuccess = this.onSelectSuccess.bind(this);
    this.onSelectFailure = this.onSelectFailure.bind(this);
    this.onSelectFinally = this.onSelectFinally.bind(this);
  }

  /**
   * Whenever the user select a theme
   * @param theme A theme
   */
  handleThemeSelected(theme) {
    this.select(theme);
  }

  /**
   * Populates the component with data
   * @returns {Promise<void>}
   */
  async populate() {
    this.props.loadingContext.add();
    const themes = await this.props.context.port.request("passbolt.themes.find-all");
    const selectedTheme = this.props.context.userSettings.getTheme();
    this.setState({ themes, selectedTheme });
    this.props.loadingContext.remove();
  }

  /**
   * Selects a new theme
   * @param {{name: string}} theme the name of the selected theme
   */
  select(theme) {
    if (this.state.selectedTheme === theme.name) {
      return;
    }
    this.props.loadingContext.add();
    this.setState({ selectedTheme: theme.name });
    return this.props.context.port
      .request("passbolt.themes.change", theme.name)
      .then(this.onSelectSuccess)
      .catch(this.onSelectFailure)
      .finally(this.onSelectFinally);
  }

  /**
   * Whenever the new theme has been selected with success
   * @returns {Promise<void>}
   */
  async onSelectSuccess() {
    await this.props.actionFeedbackContext.displaySuccess(this.props.t("The theme has been updated successfully"));
  }

  /**
   * Whenever the a new theme has been selected with failure
   * @param {object} error the error to display
   */
  async onSelectFailure(error) {
    const errorDialogProps = {
      error: error,
    };
    this.props.dialogContext.open(NotifyError, errorDialogProps);
  }

  /**
   * Whenever the new theme has been selected finally
   */
  async onSelectFinally() {
    await this.props.loadingContext.remove();
  }

  /**
   * Returns the theme preview SVG component.
   * @param {object} theme
   * @returns {ReactDOM}
   */
  getThemePreview(theme) {
    return {
      default: <DefaultThemeSVG />,
      midgar: <MidgarThemeSVG />,
      solarized_light: <SolarizedLightThemeSVG />,
      solarized_dark: <SolarizedDarkThemeSVG />,
    }[theme.name];
  }

  /**
   * Returns the name of the given theme.
   * @param {object} theme
   * @returns {string}
   */
  getThemeName(theme) {
    return {
      default: "Default",
      midgar: "Midgar",
      solarized_light: "Solarized Light",
      solarized_dark: "Solarized Dark",
    }[theme.name];
  }

  /**
   * Render the component
   */
  render() {
    const selectedClass = (theme) => (this.state.selectedTheme === theme.name ? "selected" : "");
    return (
      <div className="main-column profile-theme">
        <div className="main-content">
          <h3>
            <Trans>Theme</Trans>
          </h3>
          <div className="themes">
            {this.state.themes.map((theme) => (
              <button
                key={theme.id}
                className={`main-cell theme ${selectedClass(theme)}`}
                type="button"
                onClick={() => this.handleThemeSelected(theme)}
              >
                {this.getThemePreview(theme)}
                <div className="theme-desc">{this.getThemeName(theme)}</div>
              </button>
            ))}
          </div>
        </div>
      </div>
    );
  }
}

DisplayUserTheme.propTypes = {
  context: PropTypes.any, // The application context
  actionFeedbackContext: PropTypes.object, // The action feedback context
  dialogContext: PropTypes.object, // The dialog context
  loadingContext: PropTypes.object, // The loading context
  t: PropTypes.func, // The translation function
};

export default withAppContext(withActionFeedback(withDialog(withLoading(withTranslation("common")(DisplayUserTheme)))));