@instructure/ui-top-nav-bar 8.30.1-snapshot-15

package/es/TopNavBar/TopNavBarBrand/index.js

@@ -0,0 +1,117 @@
+var _dec, _dec2, _class, _class2;
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, 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.
+ */
+
+/** @jsx jsx */
+import React, { Component } from 'react';
+import { getElementType, omitProps } from '@instructure/ui-react-utils';
+import { testable } from '@instructure/ui-testable';
+import { withStyle, jsx } from '@instructure/emotion';
+import { ScreenReaderContent } from '@instructure/ui-a11y-content';
+import { View } from '@instructure/ui-view';
+import { TopNavBarContext } from '../TopNavBarContext';
+import generateStyle from './styles';
+import generateComponentTheme from './theme';
+import { propTypes, allowedProps } from './props';
+
+/**
+---
+parent: TopNavBar
+id: TopNavBar.Brand
+---
+@module TopNavBarBrand
+@tsProps
+**/
+let TopNavBarBrand = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = testable(), _dec(_class = _dec2(_class = (_class2 = class TopNavBarBrand extends Component {
+  constructor() {
+    super(...arguments);
+    this.ref = null;
+
+    this.handleRef = el => {
+      const elementRef = this.props.elementRef;
+      this.ref = el;
+
+      if (typeof elementRef === 'function') {
+        elementRef(el);
+      }
+    };
+  }
+
+  componentDidMount() {
+    var _this$props$makeStyle, _this$props;
+
+    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props, this.makeStylesVariables);
+  }
+
+  componentDidUpdate() {
+    var _this$props$makeStyle2, _this$props2;
+
+    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2, this.makeStylesVariables);
+  }
+
+  get makeStylesVariables() {
+    return {
+      layout: this.context.layout
+    };
+  }
+
+  render() {
+    const _this$props3 = this.props,
+          screenReaderLabel = _this$props3.screenReaderLabel,
+          renderName = _this$props3.renderName,
+          renderIcon = _this$props3.renderIcon,
+          href = _this$props3.href,
+          onClick = _this$props3.onClick,
+          styles = _this$props3.styles;
+    const ElementType = getElementType(TopNavBarBrand, this.props);
+    return jsx("div", {
+      ref: this.handleRef,
+      css: styles === null || styles === void 0 ? void 0 : styles.topNavBarBrand
+    }, (renderIcon || renderName) && jsx(View, Object.assign({}, omitProps(this.props, allowedProps), {
+      css: styles === null || styles === void 0 ? void 0 : styles.container,
+      as: ElementType,
+      href: href,
+      onClick: onClick,
+      position: "relative",
+      focusColor: this.context.inverseColor ? 'info' : 'inverse',
+      focusPosition: "inset",
+      borderRadius: "medium",
+      themeOverride: {
+        focusOutlineInset: styles === null || styles === void 0 ? void 0 : styles.focusOutlineInset
+      }
+    }), jsx(ScreenReaderContent, null, screenReaderLabel), renderIcon && this.context.layout !== 'smallViewport' && jsx("div", {
+      css: styles === null || styles === void 0 ? void 0 : styles.iconContainer,
+      role: "presentation",
+      "aria-hidden": "true"
+    }, renderIcon), renderName && jsx("div", {
+      css: styles === null || styles === void 0 ? void 0 : styles.nameContainer,
+      role: "presentation",
+      "aria-hidden": "true"
+    }, renderName)));
+  }
+
+}, _class2.displayName = "TopNavBarBrand", _class2.componentId = 'TopNavBar.Brand', _class2.propTypes = propTypes, _class2.allowedProps = allowedProps, _class2.defaultProps = {}, _class2.contextType = TopNavBarContext, _class2)) || _class) || _class);
+export { TopNavBarBrand };
+export default TopNavBarBrand;

package/es/TopNavBar/TopNavBarBrand/props.js

@@ -0,0 +1,37 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, 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 PropTypes from 'prop-types';
+const propTypes = {
+  screenReaderLabel: PropTypes.string.isRequired,
+  renderName: PropTypes.node,
+  renderIcon: PropTypes.node,
+  nameBackground: PropTypes.string,
+  iconBackground: PropTypes.string,
+  href: PropTypes.string,
+  onClick: PropTypes.func,
+  as: PropTypes.elementType,
+  elementRef: PropTypes.func
+};
+const allowedProps = ['screenReaderLabel', 'renderName', 'renderIcon', 'nameBackground', 'iconBackground', 'href', 'onClick', 'as', 'elementRef'];
+export { propTypes, allowedProps };

package/es/TopNavBar/TopNavBarBrand/styles.js

@@ -0,0 +1,91 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, 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.
+ */
+
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} props the props of the component, the style is applied to
+ * @param  {Object} state the state of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+const generateStyle = (componentTheme, props, state) => {
+  const nameBackground = props.nameBackground,
+        iconBackground = props.iconBackground;
+  const isDesktop = state.layout === 'desktop';
+  return {
+    topNavBarBrand: {
+      label: 'topNavBarBrand',
+      display: 'flex',
+      alignItems: 'stretch'
+    },
+    container: {
+      label: 'topNavBarBrand__container',
+      display: 'flex',
+      justifyContent: 'flex-start',
+      alignItems: 'stretch',
+      border: 0,
+      outline: 0,
+      padding: 0,
+      margin: 0,
+      appearance: 'none',
+      textDecoration: 'none'
+    },
+    nameContainer: {
+      label: 'topNavBarBrand__nameContainer',
+      display: 'flex',
+      justifyContent: 'center',
+      alignItems: 'center',
+      pointerEvents: 'none',
+      padding: componentTheme.logoPadding,
+      background: isDesktop ? nameBackground : void 0
+    },
+    name: {
+      label: 'topNavBarBrand__name',
+      display: 'flex',
+      alignItems: 'center',
+      height: componentTheme.logoHeight
+    },
+    iconContainer: {
+      label: 'topNavBarBrand__iconContainer',
+      display: 'flex',
+      justifyContent: 'center',
+      alignItems: 'center',
+      pointerEvents: 'none',
+      padding: componentTheme.iconPadding,
+      background: isDesktop ? iconBackground : void 0
+    },
+    icon: {
+      label: 'topNavBarBrand__icon',
+      display: 'flex',
+      justifyContent: 'center',
+      alignItems: 'center'
+    },
+    focusOutlineInset: componentTheme.focusOutlineInset
+  };
+};
+
+export default generateStyle;

package/es/TopNavBar/TopNavBarBrand/theme.js

@@ -0,0 +1,42 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, 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.
+ */
+
+/**
+ * Generates the theme object for the component from the theme and provided additional information
+ * @param  {Object} theme The actual theme object.
+ * @return {Object} The final theme object with the overrides and component variables
+ */
+const generateComponentTheme = theme => {
+  const spacing = theme.spacing;
+  const componentVariables = {
+    logoHeight: '2.25rem',
+    logoPadding: spacing.small,
+    iconPadding: spacing.small,
+    focusOutlineInset: '-0.25rem'
+  };
+  return { ...componentVariables
+  };
+};
+
+export default generateComponentTheme;

package/es/TopNavBar/TopNavBarContext.js

@@ -0,0 +1,37 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, 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 { createContext } from 'react';
+
+/**
+---
+private: true
+---
+@module TopNavBarContext
+**/
+const TopNavBarContext = /*#__PURE__*/createContext({
+  layout: 'desktop',
+  inverseColor: false
+});
+export default TopNavBarContext;
+export { TopNavBarContext };

package/es/TopNavBar/TopNavBarItem/TopNavBarItemLocator.js

@@ -0,0 +1,114 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, 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 { locator } from '@instructure/ui-test-locator';
+import { find } from '@instructure/ui-test-utils';
+import { getComputedStyle } from '@instructure/ui-dom-utils';
+/* eslint-disable no-restricted-imports */
+// @ts-expect-error bypass no type definition found error
+
+import { BaseButtonLocator } from '@instructure/ui-buttons/es/BaseButton/BaseButtonLocator'; // @ts-expect-error bypass no type definition found error
+
+import { TooltipLocator } from '@instructure/ui-tooltip/es/Tooltip/TooltipLocator'; // @ts-expect-error bypass no type definition found error
+
+import { AvatarLocator } from '@instructure/ui-avatar/es/Avatar/AvatarLocator'; // @ts-expect-error bypass no type definition found error
+
+import { DrilldownLocator } from '@instructure/ui-drilldown/es/Drilldown/DrilldownLocator'; // @ts-expect-error bypass no type definition found error
+
+import { PopoverLocator } from '@instructure/ui-popover/es/Popover/PopoverLocator';
+/* eslint-enable no-restricted-imports */
+
+import { TopNavBarItem } from './index'; // @ts-expect-error ts-migrate(2339) FIXME: Property 'selector' does not exist on type 'typeof... Remove this comment to see the full error message
+
+export const TopNavBarItemLocator = locator(TopNavBarItem.selector, {
+  findButton: function () {
+    return BaseButtonLocator.find(...arguments);
+  },
+  getButtonBackground: async () => {
+    const buttonContent = await find('[class$="-baseButton__content"]');
+    return buttonContent ? getComputedStyle(buttonContent.getDOMNode()).backgroundColor : void 0;
+  },
+  getButtonBorder: async () => {
+    const buttonContent = await find('[class$="-baseButton__content"]');
+    return buttonContent ? getComputedStyle(buttonContent.getDOMNode()).border : void 0;
+  },
+  getButtonOpacity: async () => {
+    const buttonContent = await find('[class$="-baseButton__content"]');
+    return buttonContent ? getComputedStyle(buttonContent.getDOMNode()).opacity : void 0;
+  },
+  getFocusRingColor: async () => {
+    const buttonContent = await find('[class$="-baseButton"]');
+    return buttonContent ? getComputedStyle(buttonContent.getDOMNode(), '::before').borderColor : void 0;
+  },
+  getActiveIndicatorStyle: async () => {
+    const container = await find('[class$="-topNavBarItem__container"]');
+    return getComputedStyle(container.getDOMNode(), '::after');
+  },
+  findContent: function () {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    return find('[class$="-topNavBarItem__content"]', ...args);
+  },
+  findSubmenu: function () {
+    return DrilldownLocator.find(...arguments);
+  },
+  findCustomPopover: async function () {
+    const popover = await PopoverLocator.find(...arguments);
+
+    if (popover) {
+      const isDrilldown = popover.getAttribute('data-cid').includes('Drilldown');
+      return isDrilldown ? null : popover;
+    } else {
+      return popover;
+    }
+  },
+  findTooltip: function () {
+    return TooltipLocator.find(...arguments);
+  },
+  findIcon: function () {
+    for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+      args[_key2] = arguments[_key2];
+    }
+
+    return find('[class*="-baseButton__icon"] [class$="-svgIcon"]', ...args);
+  },
+  findSubmenuChevron: function () {
+    for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
+      args[_key3] = arguments[_key3];
+    }
+
+    return find('[class$="-topNavBarItem__submenuIcon"] [class$="-svgIcon"]', ...args);
+  },
+  findAvatar: function () {
+    return AvatarLocator.find(...arguments);
+  },
+  findScreenReaderLabel: function () {
+    for (var _len4 = arguments.length, args = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
+      args[_key4] = arguments[_key4];
+    }
+
+    return find('[class$="-screenReaderContent"]', ...args);
+  }
+});