@instructure/ui-tabs 11.6.0 → 11.6.1-snapshot-129

package/src/Tabs/v2/Tab/props.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 type {
+  OtherHTMLAttributes,
+  Renderable,
+  TabsTabTheme
+} from '@instructure/shared-types'
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
+import type { ViewOwnProps } from '@instructure/ui-view/latest'
+
+type TabsTabOwnProps = {
+  variant?: 'default' | 'secondary'
+  id: string
+  index: number
+  controls: string
+  isDisabled?: boolean
+  isSelected?: boolean
+  onClick?: (
+    event: React.MouseEvent<ViewOwnProps>,
+    tabData: { index: number; id: string }
+  ) => void
+  onKeyDown?: (
+    event: React.KeyboardEvent<ViewOwnProps>,
+    tabData: { index: number; id: string }
+  ) => void
+  children?: Renderable
+  /**
+   * Whether tabOverflow prop in Tabs is set to 'scroll'.
+   */
+  isOverflowScroll?: boolean
+}
+
+type PropKeys = keyof TabsTabOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type TabsTabProps = TabsTabOwnProps &
+  WithStyleProps<TabsTabTheme, TabsTabStyle> &
+  OtherHTMLAttributes<TabsTabOwnProps>
+
+type TabsTabStyle = ComponentStyle<'tab'>
+
+const allowedProps: AllowedPropKeys = [
+  'variant',
+  'id',
+  'index',
+  'controls',
+  'isDisabled',
+  'isSelected',
+  'onClick',
+  'onKeyDown',
+  'children',
+  'isOverflowScroll'
+]
+
+export type { TabsTabProps, TabsTabStyle }
+export { allowedProps }

package/src/Tabs/v2/Tab/styles.ts

@@ -0,0 +1,161 @@
+/*
+ * 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 { keyframes } from '@instructure/emotion'
+
+import type { NewComponentTypes } from '@instructure/ui-themes'
+import type { TabsTabProps, TabsTabStyle } from './props'
+
+type StyleParams = {
+  variant: TabsTabProps['variant']
+  isSelected: TabsTabProps['isSelected']
+  isDisabled: TabsTabProps['isDisabled']
+  isOverflowScroll: TabsTabProps['isOverflowScroll']
+}
+
+// keyframes have to be outside of 'generateStyle',
+// since it is causing problems in style recalculation
+const selectedTab = keyframes`
+  to {
+    opacity: 1;
+    transform: translate3d(0, 0, 0) scaleX(1);
+  }`
+
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} params the props and passed through data of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+const generateStyle = (
+  componentTheme: NewComponentTypes['TabsTab'],
+  params: StyleParams
+): TabsTabStyle => {
+  const { variant, isSelected, isDisabled, isOverflowScroll } = params
+
+  const variants = {
+    default: {
+      padding: '1rem 1.25rem', // if horizontal padding changes, update `scrollOverlayWidthDefault` in `Tabs/theme.js`
+      lineHeight: 1,
+      position: 'relative',
+      zIndex: componentTheme.zIndex,
+      color: componentTheme.defaultTextColor,
+
+      ...(isDisabled && { fontWeight: 'normal' }),
+
+      '&::after': {
+        content: '""',
+        height: '0.25rem',
+        width: '100%',
+        position: 'absolute',
+        insetInlineStart: 0,
+        bottom: 0,
+        opacity: 0,
+        transform: 'translate3d(0, 0, 0) scaleX(0.01)',
+        ...(isSelected && {
+          backgroundColor: componentTheme.defaultSelectedBorderColor,
+          animationName: selectedTab,
+          animationDuration: '0.2s',
+          animationFillMode: 'forwards',
+          animationTimingFunction: 'ease-out'
+        })
+      },
+
+      '&:hover': {
+        ...(!isDisabled &&
+          !isSelected && {
+            borderBottomColor: componentTheme.defaultHoverBorderColor
+          })
+      }
+    },
+    secondary: {
+      padding: '0.75rem 1rem', // if horizontal padding changes, update `scrollOverlayWidthSecondary` in `Tabs/theme.js`
+      color: componentTheme.secondaryTextColor,
+      marginInlineEnd: '0.2em',
+      marginBottom: isOverflowScroll ? '0rem' : '-0.0625rem',
+      border: '0.0625rem solid transparent',
+      borderTopLeftRadius: '0.1875rem',
+      borderTopRightRadius: '0.1875rem',
+      position: 'relative',
+
+      ...(isSelected && {
+        background: componentTheme.secondarySelectedBackground,
+        borderColor: componentTheme.secondarySelectedBorderColor,
+        zIndex: componentTheme.zIndex,
+        borderBottomColor: componentTheme.secondarySelectedBackground,
+        color: componentTheme.secondarySelectedTextColor
+      }),
+
+      '&:first-of-type': { marginInlineStart: '0' },
+
+      '&:hover': {
+        ...(!isDisabled &&
+          !isSelected && {
+            background: componentTheme.secondarySelectedBackground,
+            borderColor: componentTheme.secondarySelectedBorderColor,
+            color: componentTheme.secondarySelectedTextColor
+          })
+      }
+    }
+  }
+
+  // overrides for View default focus ring
+  const focusRingStyles = {
+    '&:before': {
+      inset: '0.5rem',
+      borderRadius: '0.25rem'
+    },
+
+    '&:focus': {
+      '&:before': {
+        inset: '0.375rem'
+      }
+    }
+  }
+
+  return {
+    tab: {
+      label: 'tab',
+      fontFamily: componentTheme.fontFamily,
+      fontWeight: componentTheme.fontWeight,
+      lineHeight: componentTheme.lineHeight,
+      fontSize: componentTheme.fontSize,
+      cursor: 'pointer',
+      userSelect: 'none',
+      whiteSpace: 'nowrap',
+
+      ...((isSelected || isDisabled) && { cursor: 'default' }),
+      ...(isDisabled && { opacity: 0.5 }),
+
+      ...focusRingStyles,
+
+      ...variants[variant!]
+    }
+  }
+}
+
+export default generateStyle