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

package/src/TopNavBar/TopNavBarMenuItems/props.ts

@@ -0,0 +1,133 @@
+/*
+ * 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 { Children as ChildrenPropTypes } from '@instructure/ui-prop-types'
+
+import type { WithDeterministicIdProps } from '@instructure/ui-react-utils'
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
+import type {
+  TopNavBarMenuItemsTheme,
+  OtherHTMLAttributes,
+  PropValidators,
+  ChildrenOfType
+} from '@instructure/shared-types'
+
+import { TopNavBarItem } from '../TopNavBarItem'
+import type { ItemChild } from '../TopNavBarItem/props'
+
+import { TopNavBarMenuItems } from './index'
+
+type MenuItemsChild = React.ComponentElement<
+  TopNavBarMenuItemsProps,
+  TopNavBarMenuItems
+>
+
+type TopNavBarMenuItemsOwnProps = {
+  /**
+   * Children of type: `<TopNavBar.Item>`.
+   *
+   * In __desktop__ mode the items are listed on the navbar. See `renderHiddenItemsMenuTriggerLabel` prop description for overflow logic.
+   *
+   * In __smallViewport__ mode the items are accessible under the main "hamburger" menu.
+   */
+  children?: ChildrenOfType<ItemChild>
+
+  /**
+   * The `id` of the link to the current page. Marks the item by setting `aria-current="page"` attribute on it and setting its status to 'active'.
+   *
+   * (Note: only non-disabled, `variant="default"` items can be set to current/active.)
+   */
+  currentPageId?: string
+
+  /**
+   * In __desktop__ mode, required label for the trigger item of the hidden list items menu.
+   *
+   * When there is not enough room to list all the menu items,
+   * they will be accessible via a dropdown menu at the end of the list.
+   */
+  renderHiddenItemsMenuTriggerLabel: (
+    hiddenChildrenCount: number
+  ) => React.ReactNode
+
+  /**
+   * In __desktop__ mode, 'aria-label' for the `<ul>` container.
+   */
+  listLabel?: string
+
+  /**
+   * A function that returns a reference to root HTML element
+   */
+  elementRef?: (el: HTMLUListElement | null) => void
+}
+
+type PropKeys = keyof TopNavBarMenuItemsOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type TopNavBarMenuItemsProps = TopNavBarMenuItemsOwnProps &
+  WithStyleProps<TopNavBarMenuItemsTheme, TopNavBarMenuItemsStyle> &
+  WithDeterministicIdProps &
+  OtherHTMLAttributes<TopNavBarMenuItemsOwnProps>
+
+type TopNavBarMenuItemsStyle = ComponentStyle<
+  'topNavBarMenuItems' | 'submenuOption' | 'submenuOptionActive'
+> & {
+  itemSpacing: string
+}
+
+type TopNavBarMenuItemsState = {
+  key: number
+  visibleItemsCount?: number
+}
+
+const propTypes: PropValidators<PropKeys> = {
+  children: ChildrenPropTypes.oneOf([TopNavBarItem]),
+  currentPageId: PropTypes.string,
+  renderHiddenItemsMenuTriggerLabel: PropTypes.oneOfType([
+    PropTypes.func,
+    PropTypes.string
+  ]).isRequired,
+  listLabel: PropTypes.string,
+  elementRef: PropTypes.func
+}
+
+const allowedProps: AllowedPropKeys = [
+  'children',
+  'currentPageId',
+  'renderHiddenItemsMenuTriggerLabel',
+  'listLabel',
+  'elementRef'
+]
+
+export type {
+  MenuItemsChild,
+  TopNavBarMenuItemsProps,
+  TopNavBarMenuItemsOwnProps,
+  TopNavBarMenuItemsStyle,
+  TopNavBarMenuItemsState
+}
+export { propTypes, allowedProps }

package/src/TopNavBar/TopNavBarMenuItems/styles.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 { TopNavBarMenuItemsTheme } from '@instructure/shared-types'
+import type { TopNavBarMenuItemsStyle } 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: TopNavBarMenuItemsTheme
+): TopNavBarMenuItemsStyle => {
+  const submenuOptionStyle = {
+    display: 'inline-block',
+    padding: `0 ${componentTheme.desktopSubmenuActiveOptionIndicatorSpacing}`
+  }
+
+  return {
+    topNavBarMenuItems: {
+      label: 'topNavBarMenuItems',
+      flex: '1 1',
+      display: 'flex',
+      flexDirection: 'row',
+      alignItems: 'stretch',
+      // padding to prevent focus ring getting cropped by `overflow: hidden`
+      padding: '0 0.125rem'
+    },
+    submenuOption: {
+      label: 'topNavBarMenuItems__submenuOption',
+      ...submenuOptionStyle
+    },
+    submenuOptionActive: {
+      label: 'topNavBarMenuItems__submenuOptionActive',
+      ...submenuOptionStyle,
+      fontWeight: componentTheme.desktopSubmenuActiveOptionFontWeight,
+      paddingBlockEnd:
+        componentTheme.desktopSubmenuActiveOptionIndicatorSpacing,
+      borderBottom: `${componentTheme.desktopSubmenuActiveOptionIndicatorWidth} solid ${componentTheme.desktopSubmenuActiveOptionIndicatorColor}`
+    },
+    itemSpacing: componentTheme.desktopItemSpacing
+  }
+}
+
+export default generateStyle

package/src/TopNavBar/TopNavBarMenuItems/theme.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 { TopNavBarMenuItemsTheme } 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): TopNavBarMenuItemsTheme => {
+  const { borders, typography } = theme
+
+  const componentVariables: TopNavBarMenuItemsTheme = {
+    desktopItemSpacing: '1rem',
+    desktopMaxWidth: '100%',
+
+    desktopSubmenuActiveOptionFontWeight: typography?.fontWeightBold,
+    desktopSubmenuActiveOptionIndicatorSpacing: '0.25rem',
+    desktopSubmenuActiveOptionIndicatorWidth: borders?.widthMedium,
+    desktopSubmenuActiveOptionIndicatorColor: 'currentColor'
+  }
+
+  return {
+    ...componentVariables
+  }
+}
+
+export default generateComponentTheme

package/src/TopNavBar/TopNavBarUser/TopNavBarUserLocator.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 { TopNavBarUser } 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 TopNavBarUserLocator = locator(TopNavBarUser.selector, {
+  /* custom component query methods go here */
+})

package/src/TopNavBar/TopNavBarUser/index.tsx

@@ -0,0 +1,133 @@
+/*
+ * 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, Children } from 'react'
+
+import { error } from '@instructure/console'
+import { omitProps } from '@instructure/ui-react-utils'
+import { testable } from '@instructure/ui-testable'
+
+import { withStyle, jsx } from '@instructure/emotion'
+
+import { TopNavBarContext } from '../TopNavBarContext'
+import type { ItemChild, TopNavBarItemProps } from '../TopNavBarItem/props'
+
+import generateStyle from './styles'
+
+import { propTypes, allowedProps } from './props'
+import type { TopNavBarUserProps } from './props'
+
+/**
+---
+parent: TopNavBar
+id: TopNavBar.User
+---
+@module TopNavBarUser
+@tsProps
+**/
+@withStyle(generateStyle, null)
+@testable()
+class TopNavBarUser extends Component<TopNavBarUserProps> {
+  static readonly componentId = 'TopNavBar.User'
+
+  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?.()
+  }
+
+  componentDidUpdate() {
+    this.props.makeStyles?.()
+  }
+
+  get content() {
+    const children = React.Children.toArray(this.props.children) as ItemChild[]
+
+    const allowedVariants: TopNavBarItemProps['variant'][] = [
+      'default',
+      'button',
+      'avatar'
+    ]
+
+    return Children.map(children, (child) => {
+      const { id, variant } = child.props
+
+      if (variant && !allowedVariants.includes(variant)) {
+        error(
+          false,
+          `Item with id "${id}" has "${variant}" variant, but only the following variants are allowed in <TopNavBarUser>: ${allowedVariants.join(
+            ', '
+          )}.`
+        )
+        return null
+      }
+
+      return child
+    })
+  }
+
+  render() {
+    const { styles } = this.props
+
+    if (!this.content || this.content.length === 0) {
+      return null
+    }
+
+    if (this.context.layout === 'smallViewport') {
+      // in smallViewport mode it is rendered as a Drilldown
+      return null
+    }
+
+    return (
+      <div
+        {...omitProps(this.props, allowedProps)}
+        ref={this.handleRef}
+        css={styles?.topNavBarUser}
+      >
+        {this.content}
+      </div>
+    )
+  }
+}
+
+export { TopNavBarUser }
+export default TopNavBarUser

package/src/TopNavBar/TopNavBarUser/props.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 { Children as ChildrenPropTypes } from '@instructure/ui-prop-types'
+
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
+import type {
+  OtherHTMLAttributes,
+  PropValidators,
+  ChildrenOfType
+} from '@instructure/shared-types'
+
+import { TopNavBarItem } from '../TopNavBarItem'
+import type { ItemChild } from '../TopNavBarItem/props'
+
+import { TopNavBarUser } from './index'
+
+type UserChild = React.ComponentElement<TopNavBarUserProps, TopNavBarUser>
+
+type TopNavBarUserOwnProps = {
+  /**
+   * Required children of type TopNavBar.Item.
+   *
+   * Only accepts 'default', 'button' and 'avatar' variants.
+   *
+   * In "smallViewport" mode it will always display as text (with or without avatar).
+   */
+  children: ChildrenOfType<ItemChild>
+
+  /**
+   * A function that returns a reference to root HTML element
+   */
+  elementRef?: (el: HTMLDivElement | null) => void
+}
+
+type PropKeys = keyof TopNavBarUserOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type TopNavBarUserProps = TopNavBarUserOwnProps &
+  WithStyleProps<null, TopNavBarUserStyle> &
+  OtherHTMLAttributes<TopNavBarUserOwnProps>
+
+type TopNavBarUserStyle = ComponentStyle<'topNavBarUser'>
+
+const propTypes: PropValidators<PropKeys> = {
+  children: ChildrenPropTypes.oneOf([TopNavBarItem]).isRequired,
+  elementRef: PropTypes.func
+}
+
+const allowedProps: AllowedPropKeys = ['children', 'elementRef']
+
+export type {
+  UserChild,
+  TopNavBarUserProps,
+  TopNavBarUserOwnProps,
+  TopNavBarUserStyle
+}
+export { propTypes, allowedProps }

package/src/TopNavBar/TopNavBarUser/styles.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 type { TopNavBarUserStyle } 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 = (): TopNavBarUserStyle => {
+  return {
+    topNavBarUser: {
+      label: 'topNavBarUser',
+      flex: '0 0',
+      display: 'flex'
+    }
+  }
+}
+
+export default generateStyle

package/src/TopNavBar/index.tsx

@@ -0,0 +1,142 @@
+/*
+ * 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, { Component } from 'react'
+
+import { error } from '@instructure/console'
+import { testable } from '@instructure/ui-testable'
+import { px } from '@instructure/ui-utils'
+import { matchComponentTypes } from '@instructure/ui-react-utils'
+
+import { Responsive } from '@instructure/ui-responsive'
+
+import { TopNavBarActionItems } from './TopNavBarActionItems'
+import { TopNavBarBrand } from './TopNavBarBrand'
+import { TopNavBarItem } from './TopNavBarItem'
+import { TopNavBarLayout } from './TopNavBarLayout'
+import { TopNavBarMenuItems } from './TopNavBarMenuItems'
+import { TopNavBarUser } from './TopNavBarUser'
+
+import { TopNavBarContext } from './TopNavBarContext'
+import type { TopNavBarLayouts } from './TopNavBarContext'
+
+import { propTypes, allowedProps } from './props'
+import type { TopNavBarProps } from './props'
+
+/**
+---
+category: components
+---
+@tsProps
+**/
+@testable()
+class TopNavBar extends Component<TopNavBarProps> {
+  static readonly componentId = 'TopNavBar'
+
+  // TODO: mention subcomponent registration in "new component" docs
+  static ActionItems = TopNavBarActionItems
+  static Brand = TopNavBarBrand
+  static Item = TopNavBarItem
+  static Layout = TopNavBarLayout
+  static MenuItems = TopNavBarMenuItems
+  static User = TopNavBarUser
+
+  static contextType = TopNavBarContext
+
+  static propTypes = propTypes
+  static allowedProps = allowedProps
+  static defaultProps = {
+    breakpoint: 1024,
+    mediaQueryMatch: 'media',
+    inverseColor: false
+  }
+
+  ref: HTMLDivElement | null = null
+
+  handleRef = (el: HTMLDivElement | null) => {
+    const { elementRef } = this.props
+
+    this.ref = el
+
+    if (typeof elementRef === 'function') {
+      elementRef(el)
+    }
+  }
+
+  get breakpoint() {
+    return px(this.props.breakpoint!)
+  }
+
+  render() {
+    const { children, mediaQueryMatch, inverseColor } = this.props
+
+    return (
+      <Responsive
+        elementRef={this.handleRef}
+        match={mediaQueryMatch}
+        query={{
+          smallViewport: { maxWidth: this.breakpoint - 1 },
+          desktop: { minWidth: this.breakpoint }
+        }}
+        render={(_props, matches) => {
+          const layout = matches
+            ? (matches[0] as TopNavBarLayouts)
+            : 'smallViewport'
+
+          const isInverseColor =
+            typeof inverseColor === 'function'
+              ? inverseColor(layout)
+              : !!inverseColor
+
+          const content = children({
+            currentLayout: layout,
+            inverseColor: isInverseColor
+          })
+
+          if (!matchComponentTypes(content, [TopNavBarLayout])) {
+            error(
+              false,
+              'The `children` function prop of TopNavBar has to return a child of type <TopNavBar.Layout>, but it returned:',
+              content
+            )
+          }
+
+          return (
+            <TopNavBarContext.Provider
+              value={{
+                layout,
+                inverseColor: isInverseColor
+              }}
+            >
+              {content}
+            </TopNavBarContext.Provider>
+          )
+        }}
+      />
+    )
+  }
+}
+
+export { TopNavBar }
+export default TopNavBar