@oceanbase/ui 0.2.0

package/es/BasicLayout/Header.js

@@ -0,0 +1,228 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+var _excluded = ["showLabel", "title", "extra", "pathname", "welcomePath", "docsPath", "pdfPath", "iconUrl", "logoUrl", "simpleLogoUrl", "username", "userMenu", "appData", "locale", "showHelp", "showLocale", "locales", "langs"];
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+import { BulbFilled, BulbOutlined, CopyrightOutlined, ReadFilled, UserOutlined } from '@ant-design/icons';
+import { Button, Dropdown, Menu, Modal, Space, Tooltip } from '@oceanbase/design';
+import classNames from 'classnames';
+import moment from 'moment';
+import React, { useState } from 'react';
+import { OB_SITE_LINK } from "../constant";
+import LocaleWrapper from "../locale/LocaleWrapper";
+import { directTo, getPrefix } from "../_util";
+import useHistory from "../_util/useHistory";
+import zhCN from "./locale/zh-CN";
+// @ts-ignore
+import logoImg from "../assets/logo/oceanbase_logo.svg";
+// @ts-ignore
+// 自定义 SVG 图标需要将其导入为图片，而不能是 ReactComponent，因为需要依赖 webpack 插件
+// 虽然本地开发可以生效，但构建后的产物在上层项目中不会生效，导致 SVG 展示为空
+import UserSvg from "../assets/user.svg";
+import LocaleDropdown from "../LocaleDropdown";
+import "./Header.less";
+var prefix = getPrefix('layout-header');
+var Header = function Header(_ref) {
+  var _ref$showLabel = _ref.showLabel,
+    showLabel = _ref$showLabel === void 0 ? true : _ref$showLabel,
+    title = _ref.title,
+    extra = _ref.extra,
+    pathname = _ref.pathname,
+    welcomePath = _ref.welcomePath,
+    docsPath = _ref.docsPath,
+    pdfPath = _ref.pdfPath,
+    iconUrl = _ref.iconUrl,
+    logoUrl = _ref.logoUrl,
+    simpleLogoUrl = _ref.simpleLogoUrl,
+    username = _ref.username,
+    userMenu = _ref.userMenu,
+    _ref$appData = _ref.appData,
+    appData = _ref$appData === void 0 ? {} : _ref$appData,
+    _ref$locale = _ref.locale,
+    locale = _ref$locale === void 0 ? {} : _ref$locale,
+    _ref$showHelp = _ref.showHelp,
+    showHelp = _ref$showHelp === void 0 ? true : _ref$showHelp,
+    _ref$showLocale = _ref.showLocale,
+    showLocale = _ref$showLocale === void 0 ? false : _ref$showLocale,
+    locales = _ref.locales,
+    langs = _ref.langs,
+    restProps = _objectWithoutProperties(_ref, _excluded);
+  var history = useHistory();
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    visible = _useState2[0],
+    setVisible = _useState2[1];
+  // 是否为欢迎页
+  // 主要是为了处理与欢迎页搭配使用的场景
+  var isWelcome = pathname === welcomePath;
+  // 帮助菜单
+  var helpMenu = /*#__PURE__*/React.createElement(Menu, {
+    onClick: function onClick(_ref2) {
+      var key = _ref2.key;
+      if (key === 'welcome') {
+        history.push(welcomePath);
+      } else if (key === 'viewDocs') {
+        directTo(docsPath);
+      } else if (key === 'downloadDocs') {
+        var _pdfPath$split;
+        var ele = document.createElement('a');
+        ele.setAttribute('href', pdfPath);
+        ele.setAttribute('download', (pdfPath === null || pdfPath === void 0 ? void 0 : (_pdfPath$split = pdfPath.split('/')) === null || _pdfPath$split === void 0 ? void 0 : _pdfPath$split.pop()) || 'Docs.pdf');
+        ele.click();
+        ele.remove();
+      } else if (key === 'about') {
+        setVisible(true);
+      }
+    }
+  }, welcomePath && /*#__PURE__*/React.createElement(Menu.Item, {
+    key: "welcome"
+  }, locale.welcome), pdfPath && /*#__PURE__*/React.createElement(Menu.Item, {
+    key: "downloadDocs"
+  }, locale.downloadDocs), /*#__PURE__*/React.createElement(Menu.Item, {
+    key: "about"
+  }, "".concat(locale.about).concat(appData.shortName ? " ".concat(appData.shortName) : '')));
+  return /*#__PURE__*/React.createElement("div", _extends({}, restProps, {
+    className: classNames("".concat(prefix), _defineProperty({}, "".concat(prefix, "-welcome"), isWelcome))
+  }), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(prefix, "-content")
+  }, /*#__PURE__*/React.createElement("img", {
+    src: simpleLogoUrl,
+    alt: "",
+    onClick: function onClick() {
+      history.push('/');
+    },
+    className: "".concat(prefix, "-logo")
+  }), title && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(prefix, "-title")
+  }, title), showLabel ? /*#__PURE__*/React.createElement("div", {
+    className: "".concat(prefix, "-extra ").concat(prefix, "-extra-with-label")
+  }, extra, showHelp && /*#__PURE__*/React.createElement(Dropdown, {
+    overlay: helpMenu
+  }, /*#__PURE__*/React.createElement(Space, {
+    className: "".concat(prefix, "-extra-item")
+  }, /*#__PURE__*/React.createElement(BulbOutlined, null), /*#__PURE__*/React.createElement("span", {
+    "data-testid": "help"
+  }, locale.help))), showLocale && /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-item")
+  }, /*#__PURE__*/React.createElement(LocaleDropdown, {
+    locales: locales || langs
+  })), userMenu ? /*#__PURE__*/React.createElement(Dropdown, {
+    overlay: userMenu
+  }, /*#__PURE__*/React.createElement(Button, {
+    shape: "round",
+    size: "small"
+  }, /*#__PURE__*/React.createElement(Space, {
+    className: "".concat(prefix, "-extra-item")
+  }, /*#__PURE__*/React.createElement(UserOutlined, null), /*#__PURE__*/React.createElement("span", null, username)))) :
+  /*#__PURE__*/
+  // userMenu username 都不存在时，不展示该项
+  React.createElement(React.Fragment, null, username ? /*#__PURE__*/React.createElement(Button, {
+    shape: "round",
+    size: "small"
+  }, /*#__PURE__*/React.createElement(Space, {
+    className: "".concat(prefix, "-extra-item")
+  }, /*#__PURE__*/React.createElement(UserOutlined, null), /*#__PURE__*/React.createElement("span", null, username))) : null)) : /*#__PURE__*/React.createElement("div", {
+    className: "".concat(prefix, "-extra")
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-item")
+  }, /*#__PURE__*/React.createElement(Dropdown, {
+    overlay: helpMenu
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-icon-wrapper")
+  }, /*#__PURE__*/React.createElement(BulbFilled, null)))), docsPath && /*#__PURE__*/React.createElement(Tooltip, {
+    title: locale.viewDocs
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-item"),
+    onClick: function onClick() {
+      directTo(docsPath);
+    }
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-icon-wrapper")
+  }, /*#__PURE__*/React.createElement(ReadFilled, null)))), showLocale && /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-item")
+  }, /*#__PURE__*/React.createElement(LocaleDropdown, {
+    showLabel: true,
+    locales: locales || langs
+  })), userMenu ? /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-item")
+  }, /*#__PURE__*/React.createElement(Dropdown, {
+    overlay: userMenu
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-user-wrapper")
+  }, /*#__PURE__*/React.createElement("img", {
+    src: UserSvg,
+    alt: "",
+    className: "".concat(prefix, "-extra-user-icon"),
+    style: {
+      height: 12
+    }
+  }), /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-username")
+  }, username)))) : /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-item")
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-extra-user-wrapper")
+  }, /*#__PURE__*/React.createElement("img", {
+    src: UserSvg,
+    alt: "",
+    className: "".concat(prefix, "-extra-user-icon"),
+    style: {
+      height: 12
+    }
+  }), /*#__PURE__*/React.createElement("span", null, username))))), /*#__PURE__*/React.createElement(Modal, {
+    visible: visible
+    // Support for antd 5.0
+    ,
+    open: visible,
+    destroyOnClose: true,
+    footer: false,
+    onCancel: function onCancel() {
+      setVisible(false);
+    }
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "".concat(prefix, "-about-wrapper")
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "".concat(prefix, "-about")
+  }, /*#__PURE__*/React.createElement("img", {
+    src: logoUrl,
+    alt: "",
+    className: "".concat(prefix, "-logo")
+  }), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(prefix, "-release-info")
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "".concat(prefix, "-version")
+  }, locale.version, ": ", appData.version), appData.releaseTime && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(prefix, "-date")
+  }, "".concat(locale.releaseTime, ": ").concat(appData.releaseTime))), /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement("a", {
+    href: OB_SITE_LINK,
+    target: "_blank",
+    rel: "noopener noreferrer"
+  }, OB_SITE_LINK)), /*#__PURE__*/React.createElement("div", {
+    style: {
+      display: 'flex',
+      justifyContent: 'space-between',
+      alignItems: 'center'
+    }
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "".concat(prefix, "-copyright")
+  }, locale.right, " ", /*#__PURE__*/React.createElement(CopyrightOutlined, null), " ", moment().year(), " ", locale.company), /*#__PURE__*/React.createElement("img", {
+    src: logoImg,
+    alt: "",
+    style: {
+      height: 12
+    }
+  })))))));
+};
+export default LocaleWrapper({
+  componentName: 'BasicLayout',
+  defaultLocale: zhCN
+})(Header);

package/es/BasicLayout/Header.less

@@ -0,0 +1,134 @@
+@import '../variable.less';
+
+@prefix: ob-layout-header;
+
+.@{prefix} {
+  position: fixed;
+  z-index: 10;
+  width: 100%;
+  height: 48px;
+  padding: 10px 24px;
+  line-height: 48px;
+  background-color: @colorBgLayout;
+  box-shadow: inset 0 -1px 0 0 #e2e8f3;
+
+  .@{prefix}-content {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    max-width: @maxWidth;
+    height: 100%;
+    margin: 0 auto;
+  }
+
+  .@{prefix}-logo {
+    height: 24px;
+    cursor: pointer;
+  }
+
+  .@{prefix}-icon {
+    width: 52px;
+    height: 48px;
+    line-height: 48px;
+    text-align: center;
+    border-right: 1px solid #e2e8f3;
+    border-bottom: 1px solid #e2e8f3;
+    cursor: pointer;
+    img {
+      height: 32px;
+      margin-top: 8px;
+    }
+  }
+
+  .@{prefix}-title {
+    /* 占据剩余的全部空间 */
+    flex: 1;
+    margin: 0 16px;
+  }
+
+  .@{prefix}-extra {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    .@{prefix}-extra-item {
+      display: inline-flex;
+      font-size: 12px;
+      cursor: pointer;
+      &:not(:last-child) {
+        margin-right: 24px;
+      }
+      .@{prefix}-extra-icon-wrapper {
+        width: 28px;
+        height: 28px;
+        line-height: 28px;
+        text-align: center;
+        border: 0.88px solid #ced4e1;
+        border-radius: 14px;
+      }
+      .@{prefix}-extra-user-wrapper {
+        height: 28px;
+        padding: 0 10px;
+        line-height: 28px;
+        border: 0.88px solid #ced4e1;
+        border-radius: 14px;
+        .@{prefix}-extra-user-icon {
+          margin-right: 6px;
+          margin-bottom: -2px;
+        }
+      }
+    }
+  }
+  .@{prefix}-extra-with-label {
+    .@{prefix}-extra-item {
+      &:not(:last-child) {
+        margin-right: 24px !important;
+      }
+    }
+  }
+}
+
+.@{prefix}-welcome {
+  color: #fff;
+  background-color: transparent;
+  border-bottom: none;
+
+  .@{prefix}-extra {
+    .@{prefixCls}-btn {
+      color: #fff;
+      background-color: rgba(255, 255, 255, 0.25);
+      border: 0.5px solid rgba(0, 0, 0, 0.1);
+    }
+  }
+}
+
+.@{prefix}-about-wrapper {
+  .@{prefix}-about {
+    margin-top: 12px;
+
+    .@{prefix}-logo {
+      height: 72px;
+    }
+
+    .@{prefix}-release-info {
+      margin-top: 20px;
+      margin-bottom: 50px;
+
+      .@{prefix}-version {
+        color: #000;
+      }
+
+      .@{prefix}-date {
+        color: #000;
+        font-size: 12px;
+        font-family: Helvetica;
+        opacity: 0.45;
+      }
+    }
+
+    .@{prefix}-copyright {
+      color: #000;
+      font-size: 12px;
+      opacity: 0.45;
+    }
+  }
+}

package/es/BasicLayout/index.d.ts

@@ -0,0 +1,45 @@
+import type { BadgeProps } from 'antd/es/badge';
+import type { MenuProps } from 'antd/es/menu';
+import React from 'react';
+import type { LocaleWrapperProps } from '../locale/LocaleWrapper';
+import type { HeaderProps } from './Header';
+import './index.less';
+export interface SiderHeaderProps {
+    backUrl: string;
+    backupUrl?: string;
+    backTitle: string;
+    name: string;
+    id: number;
+    badgeProps?: BadgeProps;
+}
+export interface MenuItem {
+    link: string;
+    title: string;
+    icon?: React.ReactNode;
+    selectedIcon?: React.ReactNode;
+    accessible?: boolean;
+    divider?: boolean;
+    children?: MenuItem[];
+}
+export interface BasicLayoutProps extends LocaleWrapperProps {
+    location?: {
+        pathname: string;
+    };
+    children?: React.ReactNode;
+    banner?: React.ReactNode;
+    iconUrl?: string;
+    logoUrl: string;
+    simpleLogoUrl?: string;
+    className?: string;
+    topHeader: HeaderProps;
+    menus: MenuItem[];
+    defaultCollapsed?: boolean;
+    defaultSelectedKeys?: string[];
+    defaultOpenKeys?: string[];
+    sideHeader?: React.ReactNode;
+    subSideMenus?: MenuItem[];
+    subSideMenuProps?: MenuProps;
+    style?: React.CSSProperties;
+}
+declare const _default: any;
+export default _default;