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

package/src/TopNavBar/TopNavBarBrand/index.tsx

@@ -0,0 +1,139 @@
+/*
+ * 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'
+import type { TopNavBarBrandProps, TopNavBarBrandStyleProps } from './props'
+
+/**
+---
+parent: TopNavBar
+id: TopNavBar.Brand
+---
+@module TopNavBarBrand
+@tsProps
+**/
+@withStyle(generateStyle, generateComponentTheme)
+@testable()
+class TopNavBarBrand extends Component<TopNavBarBrandProps> {
+  static readonly componentId = 'TopNavBar.Brand'
+  // TODO: add to the docs: making it static on parent and jsdocs parent/module settings, dont export child on its own
+
+  static propTypes = propTypes
+  static allowedProps = allowedProps
+  static defaultProps = {}
+
+  declare context: React.ContextType<typeof TopNavBarContext>
+  static contextType = TopNavBarContext
+
+  ref: HTMLDivElement | null = null
+
+  handleRef = (el: HTMLDivElement | null) => {
+    const { elementRef } = this.props
+
+    this.ref = el
+
+    if (typeof elementRef === 'function') {
+      elementRef(el)
+    }
+  }
+
+  componentDidMount() {
+    this.props.makeStyles?.(this.makeStylesVariables)
+  }
+
+  componentDidUpdate() {
+    this.props.makeStyles?.(this.makeStylesVariables)
+  }
+
+  get makeStylesVariables(): TopNavBarBrandStyleProps {
+    return {
+      layout: this.context.layout
+    }
+  }
+
+  render() {
+    const { screenReaderLabel, renderName, renderIcon, href, onClick, styles } =
+      this.props
+
+    const ElementType = getElementType(TopNavBarBrand, this.props)
+
+    return (
+      <div ref={this.handleRef} css={styles?.topNavBarBrand}>
+        {(renderIcon || renderName) && (
+          <View
+            {...omitProps(this.props, allowedProps)}
+            css={styles?.container}
+            as={ElementType}
+            href={href}
+            onClick={onClick}
+            position="relative"
+            focusColor={this.context.inverseColor ? 'info' : 'inverse'}
+            focusPosition="inset"
+            borderRadius="medium"
+            themeOverride={{ focusOutlineInset: styles?.focusOutlineInset }}
+          >
+            <ScreenReaderContent>{screenReaderLabel}</ScreenReaderContent>
+            {renderIcon && this.context.layout !== 'smallViewport' && (
+              <div
+                css={styles?.iconContainer}
+                role="presentation"
+                aria-hidden="true"
+              >
+                {renderIcon}
+              </div>
+            )}
+            {renderName && (
+              <div
+                css={styles?.nameContainer}
+                role="presentation"
+                aria-hidden="true"
+              >
+                {renderName}
+              </div>
+            )}
+          </View>
+        )}
+      </div>
+    )
+  }
+}
+
+export { TopNavBarBrand }
+export default TopNavBarBrand

package/src/TopNavBar/TopNavBarBrand/props.ts

@@ -0,0 +1,146 @@
+/*
+ * 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 React from 'react'
+import PropTypes from 'prop-types'
+
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
+import type {
+  TopNavBarBrandTheme,
+  OtherHTMLAttributes,
+  PropValidators,
+  AsElementType
+} from '@instructure/shared-types'
+import type { ViewOwnProps } from '@instructure/ui-view'
+
+import type { TopNavBarContextType } from '../TopNavBarContext'
+
+import { TopNavBarBrand } from './index'
+
+type BrandChild = React.ComponentElement<TopNavBarBrandProps, TopNavBarBrand>
+
+type TopNavBarBrandOwnProps = {
+  /**
+   * A label is required for accessibility (e.g. name).
+   */
+  screenReaderLabel: string
+
+  /**
+   * The app/product/brand/company/etc. name.
+   */
+  renderName?: React.ReactNode
+
+  /**
+   * The app/product/brand/company/etc. logo or icon.
+   * The icon is not displayed in "smallViewport" mode.
+   */
+  renderIcon?: React.ReactNode
+
+  /**
+   * Background color of the brand name.
+   * The background is not displayed in "smallViewport" mode.
+   */
+  nameBackground?: string
+
+  /**
+   * Background color of the icon, usually the brand color (when an icon is provided).
+   * The background is not displayed in "smallViewport" mode.
+   */
+  iconBackground?: string
+
+  /**
+   * If the item goes to a new page, pass a href.
+   */
+  href?: string
+
+  /**
+   * If the item does not go to a new page, pass an onClick
+   */
+  onClick?: (event: React.MouseEvent<ViewOwnProps>) => void
+
+  /**
+   * The element type to render as (will default to `<a>` if href is provided)
+   */
+  as?: AsElementType
+
+  /**
+   * A function that returns a reference to root HTML element
+   */
+  elementRef?: (el: HTMLDivElement | null) => void
+}
+
+type PropKeys = keyof TopNavBarBrandOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type TopNavBarBrandProps = TopNavBarBrandOwnProps &
+  WithStyleProps<TopNavBarBrandTheme, TopNavBarBrandStyle> &
+  OtherHTMLAttributes<TopNavBarBrandOwnProps>
+
+type TopNavBarBrandStyle = ComponentStyle<
+  | 'topNavBarBrand'
+  | 'container'
+  | 'nameContainer'
+  | 'name'
+  | 'iconContainer'
+  | 'icon'
+> &
+  Pick<TopNavBarBrandTheme, 'focusOutlineInset'>
+
+type TopNavBarBrandStyleProps = {
+  layout: TopNavBarContextType['layout']
+}
+
+const propTypes: PropValidators<PropKeys> = {
+  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: AllowedPropKeys = [
+  'screenReaderLabel',
+  'renderName',
+  'renderIcon',
+  'nameBackground',
+  'iconBackground',
+  'href',
+  'onClick',
+  'as',
+  'elementRef'
+]
+
+export type {
+  BrandChild,
+  TopNavBarBrandProps,
+  TopNavBarBrandOwnProps,
+  TopNavBarBrandStyle,
+  TopNavBarBrandStyleProps
+}
+export { propTypes, allowedProps }

package/src/TopNavBar/TopNavBarBrand/styles.ts

@@ -0,0 +1,102 @@
+/*
+ * 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 type { TopNavBarBrandTheme } from '@instructure/shared-types'
+import type {
+  TopNavBarBrandProps,
+  TopNavBarBrandStyle,
+  TopNavBarBrandStyleProps
+} from './props'
+
+/**
+ * ---
+ * 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: TopNavBarBrandTheme,
+  props: TopNavBarBrandProps,
+  state: TopNavBarBrandStyleProps
+): TopNavBarBrandStyle => {
+  const { nameBackground, iconBackground } = props
+  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 : undefined
+    },
+    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 : undefined
+    },
+    icon: {
+      label: 'topNavBarBrand__icon',
+      display: 'flex',
+      justifyContent: 'center',
+      alignItems: 'center'
+    },
+    focusOutlineInset: componentTheme.focusOutlineInset
+  }
+}
+
+export default generateStyle

package/src/TopNavBar/TopNavBarBrand/theme.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 type { Theme } from '@instructure/ui-themes'
+import type { TopNavBarBrandTheme } from '@instructure/shared-types'
+
+/**
+ * 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: Theme): TopNavBarBrandTheme => {
+  const { spacing } = theme
+
+  const componentVariables: TopNavBarBrandTheme = {
+    logoHeight: '2.25rem',
+    logoPadding: spacing.small,
+    iconPadding: spacing.small,
+    focusOutlineInset: '-0.25rem'
+  }
+
+  return {
+    ...componentVariables
+  }
+}
+
+export default generateComponentTheme

package/src/TopNavBar/TopNavBarContext.ts

@@ -0,0 +1,47 @@
+/*
+ * 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'
+
+type TopNavBarLayouts = 'desktop' | 'smallViewport'
+
+type TopNavBarContextType = {
+  layout: TopNavBarLayouts
+  inverseColor: boolean
+}
+
+/**
+---
+private: true
+---
+@module TopNavBarContext
+**/
+const TopNavBarContext = createContext<TopNavBarContextType>({
+  layout: 'desktop',
+  inverseColor: false
+})
+
+export default TopNavBarContext
+export { TopNavBarContext }
+export type { TopNavBarLayouts, TopNavBarContextType }

package/src/TopNavBar/TopNavBarItem/TopNavBarItemLocator.ts

@@ -0,0 +1,111 @@
+/*
+ * 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: (...args: any[]) => {
+    return BaseButtonLocator.find(...args)
+  },
+  getButtonBackground: async () => {
+    const buttonContent = await find('[class$="-baseButton__content"]')
+    return buttonContent
+      ? getComputedStyle(buttonContent.getDOMNode()).backgroundColor
+      : undefined
+  },
+  getButtonBorder: async () => {
+    const buttonContent = await find('[class$="-baseButton__content"]')
+    return buttonContent
+      ? getComputedStyle(buttonContent.getDOMNode()).border
+      : undefined
+  },
+  getButtonOpacity: async () => {
+    const buttonContent = await find('[class$="-baseButton__content"]')
+    return buttonContent
+      ? getComputedStyle(buttonContent.getDOMNode()).opacity
+      : undefined
+  },
+  getFocusRingColor: async () => {
+    const buttonContent = await find('[class$="-baseButton"]')
+    return buttonContent
+      ? getComputedStyle(buttonContent.getDOMNode(), '::before').borderColor
+      : undefined
+  },
+  getActiveIndicatorStyle: async () => {
+    const container = await find('[class$="-topNavBarItem__container"]')
+    return getComputedStyle(container.getDOMNode(), '::after')
+  },
+  findContent: (...args: any[]) => {
+    return find('[class$="-topNavBarItem__content"]', ...args)
+  },
+  findSubmenu: (...args: any[]) => {
+    return DrilldownLocator.find(...args)
+  },
+  findCustomPopover: async (...args: any[]) => {
+    const popover = await PopoverLocator.find(...args)
+
+    if (popover) {
+      const isDrilldown = popover.getAttribute('data-cid').includes('Drilldown')
+      return isDrilldown ? null : popover
+    } else {
+      return popover
+    }
+  },
+  findTooltip: (...args: any[]) => {
+    return TooltipLocator.find(...args)
+  },
+  findIcon: (...args: any[]) => {
+    return find('[class*="-baseButton__icon"] [class$="-svgIcon"]', ...args)
+  },
+  findSubmenuChevron: (...args: any[]) => {
+    return find(
+      '[class$="-topNavBarItem__submenuIcon"] [class$="-svgIcon"]',
+      ...args
+    )
+  },
+  findAvatar: (...args: any[]) => {
+    return AvatarLocator.find(...args)
+  },
+  findScreenReaderLabel: (...args: any[]) => {
+    return find('[class$="-screenReaderContent"]', ...args)
+  }
+})