@instructure/ui-toggle-details 11.6.0 → 11.6.1-snapshot-129

package/src/ToggleDetails/v2/index.tsx

@@ -0,0 +1,205 @@
+/*
+ * 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 { Component, createRef } from 'react'
+import { Button } from '@instructure/ui-buttons/latest'
+import {
+  ChevronRightInstUIIcon,
+  ChevronDownInstUIIcon
+} from '@instructure/ui-icons'
+import { Expandable } from '@instructure/ui-expandable'
+import { omitProps, pickProps } from '@instructure/ui-react-utils'
+import { isActiveElement } from '@instructure/ui-dom-utils'
+
+import { withStyle } from '@instructure/emotion'
+import generateStyle from './styles'
+import type { ToggleDetailsProps } from './props'
+import { allowedProps } from './props'
+import type { ExpandableToggleProps } from '@instructure/ui-expandable'
+import type { ViewProps } from '@instructure/ui-view/latest'
+
+/**
+---
+category: components
+---
+**/
+@withStyle(generateStyle)
+class ToggleDetails extends Component<ToggleDetailsProps> {
+  static readonly componentId = 'ToggleDetails'
+  static allowedProps = allowedProps
+
+  static defaultProps = {
+    variant: 'default',
+    size: 'medium',
+    fluidWidth: false,
+    icon: ChevronRightInstUIIcon,
+    iconExpanded: ChevronDownInstUIIcon,
+    iconPosition: 'start',
+    defaultExpanded: false,
+    children: null
+  }
+
+  _buttonNode: HTMLElement | null = null
+  ref = createRef<HTMLDivElement>()
+
+  // TODO this solution was generated with Gemini, should be tested if it works as fine as before
+  setButtonRef = (node: Element | null) => {
+    this._buttonNode = node as HTMLElement | null
+  }
+
+  get focused() {
+    return isActiveElement(this._buttonNode)
+  }
+
+  focus() {
+    this._buttonNode?.focus()
+  }
+
+  componentDidMount() {
+    this.props.makeStyles?.()
+  }
+
+  componentDidUpdate() {
+    this.props.makeStyles?.()
+  }
+
+  renderSummary(expanded: boolean) {
+    const { summary, iconPosition } = this.props
+
+    return (
+      <span css={this.props.styles?.summary}>
+        {iconPosition === 'start' && this.renderIcon(expanded)}
+        <span css={this.props.styles?.summaryText}>{summary}</span>
+        {iconPosition === 'end' && this.renderIcon(expanded)}
+      </span>
+    )
+  }
+
+  renderToggle(
+    toggleProps: ReturnType<ExpandableToggleProps>,
+    expanded: boolean
+  ) {
+    const { variant } = this.props
+    const tProps = this.props.children
+      ? toggleProps
+      : { onClick: toggleProps.onClick }
+    const props = {
+      ...omitProps(this.props, ToggleDetails.allowedProps),
+      ...tProps,
+      children: this.renderSummary(expanded)
+    } as Record<string, unknown>
+    const summary = this.renderSummary(expanded)
+
+    if (variant === 'filled') {
+      return (
+        <Button
+          {...props}
+          display="block"
+          textAlign="start"
+          elementRef={this.setButtonRef}
+        >
+          {summary}
+        </Button>
+      )
+    } else if (props.href) {
+      return (
+        <a {...props} css={this.props.styles?.toggle} ref={this.setButtonRef}>
+          {summary}
+        </a>
+      )
+    } else {
+      return (
+        <button
+          {...props}
+          type="button"
+          css={this.props.styles?.toggle}
+          ref={this.setButtonRef}
+        >
+          {summary}
+        </button>
+      )
+    }
+  }
+
+  renderIcon(expanded: boolean) {
+    const Icon = expanded ? this.props.iconExpanded : this.props.icon
+    const iconSize = this.props.size === 'large' ? 'lg' : 'md'
+    const iconColor =
+      this.props.variant === 'filled' ? 'actionSecondaryBaseColor' : 'baseColor'
+
+    return this.props.children && Icon ? (
+      <span css={this.props.styles?.icon}>
+        <Icon size={iconSize} color={iconColor} />
+      </span>
+    ) : null
+  }
+
+  renderDetails(expanded: boolean, detailsProps: { id: string }) {
+    if (!this.props.children) return null
+    const expandedStyles = expanded ? { display: 'block' } : { display: 'none' }
+    return (
+      <div {...detailsProps} css={[this.props.styles?.details, expandedStyles]}>
+        {expanded && this.renderContent()}
+      </div>
+    )
+  }
+
+  renderContent() {
+    return <div css={this.props.styles?.content}>{this.props.children}</div>
+  }
+
+  handleToggle = (
+    event: React.KeyboardEvent<ViewProps> | React.MouseEvent<ViewProps>,
+    expanded: boolean
+  ) => {
+    if (typeof this.props.onToggle === 'function') {
+      this.props.onToggle(event, expanded)
+    }
+  }
+
+  render() {
+    return (
+      <Expandable
+        {...pickProps(this.props, Expandable.allowedProps)}
+        onToggle={this.handleToggle}
+      >
+        {({ expanded, getToggleProps, getDetailsProps }) => {
+          return (
+            <div
+              css={this.props.styles?.toggleDetails}
+              ref={this.ref}
+              data-cid="ToggleDetails"
+            >
+              {this.renderToggle(getToggleProps(), expanded)}
+              {this.renderDetails(expanded, getDetailsProps())}
+            </div>
+          )
+        }}
+      </Expandable>
+    )
+  }
+}
+
+export default ToggleDetails
+export { ToggleDetails }

package/src/ToggleDetails/v2/props.ts

@@ -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 React from 'react'
+
+import type {
+  OtherHTMLAttributes,
+  ToggleDetailsTheme
+} from '@instructure/shared-types'
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
+import type { ViewProps } from '@instructure/ui-view/latest'
+
+type ToggleDetailsOwnProps = {
+  variant?: 'default' | 'filled'
+  /**
+   * The summary that displays and can be interacted with
+   */
+  summary: React.ReactNode
+  /**
+   * Whether the content is expanded or hidden
+   */
+  expanded?: boolean // TODO: controllable(PropTypes.bool, 'onToggle', 'defaultExpanded')
+  /**
+   * Whether the content is initially expanded or hidden (uncontrolled)
+   */
+  defaultExpanded?: boolean
+  onToggle?: (
+    event: React.KeyboardEvent<ViewProps> | React.MouseEvent<ViewProps>,
+    expanded: boolean
+  ) => void
+  /**
+   * The icon to display next to the summary text when content is hidden
+   */
+  icon?: (...args: any[]) => React.ReactElement
+  /**
+   * The icon to display when content is expanded
+   */
+  iconExpanded?: (...args: any[]) => React.ReactElement
+  /**
+   * Icon position at the start or end of the summary text
+   */
+  iconPosition?: 'start' | 'end'
+  /**
+   * should the summary fill the width of its container
+   */
+  fluidWidth?: boolean
+  /**
+   * Choose a size for the expand/collapse icon
+   */
+  size?: 'small' | 'medium' | 'large'
+  /**
+   * The toggleable content passed inside the ToggleDetails component
+   */
+  children?: React.ReactNode
+}
+
+type PropKeys = keyof ToggleDetailsOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type ToggleDetailsProps = ToggleDetailsOwnProps &
+  WithStyleProps<ToggleDetailsTheme, ToggleDetailsStyle> &
+  OtherHTMLAttributes<ToggleDetailsOwnProps>
+
+type ToggleDetailsStyle = ComponentStyle<
+  | 'toggleDetails'
+  | 'summary'
+  | 'summaryText'
+  | 'toggle'
+  | 'icon'
+  | 'details'
+  | 'content'
+>
+
+type ToggleDetailsStyleProps = {
+  animate: boolean
+}
+const allowedProps: AllowedPropKeys = [
+  'variant',
+  'summary',
+  'expanded',
+  'defaultExpanded',
+  'onToggle',
+  'icon',
+  'iconExpanded',
+  'iconPosition',
+  'fluidWidth',
+  'children',
+  'size'
+]
+
+export type { ToggleDetailsProps, ToggleDetailsStyleProps, ToggleDetailsStyle }
+export { allowedProps }

package/src/ToggleDetails/v2/styles.ts

@@ -0,0 +1,188 @@
+/*
+ * 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, SharedTokens } from '@instructure/ui-themes'
+import type {
+  ToggleDetailsProps,
+  ToggleDetailsStyleProps,
+  ToggleDetailsStyle
+} from './props'
+
+const contentAnimation = keyframes`
+  to {
+    opacity: 1;
+  }`
+
+/**
+ * ---
+ * 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} sharedTokens the shared tokens of the component
+ * @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: NewComponentTypes['ToggleDetails'],
+  props: ToggleDetailsProps,
+  sharedTokens: SharedTokens,
+  _state: ToggleDetailsStyleProps
+): ToggleDetailsStyle => {
+  const { fluidWidth, iconPosition, size, variant } = props
+
+  const positionIconAtEnd =
+    iconPosition === 'end' && (variant === 'filled' || fluidWidth)
+  const fluidWidthStyles = fluidWidth ? { display: 'block', width: '100%' } : {}
+
+  const iconPositionStyles = {
+    start: {
+      marginInlineEnd: componentTheme.iconMargin,
+      marginInlineStart: 0
+    },
+    end: {
+      marginInlineStart: componentTheme.iconMargin,
+      marginInlineEnd: 0
+    }
+  }
+
+  const fontSizeStyles = {
+    small: { fontSize: componentTheme.fontSizeSmall },
+    medium: { fontSize: componentTheme.fontSizeMedium },
+    large: { fontSize: componentTheme.fontSizeLarge }
+  }
+
+  const indentDetailsStyles =
+    iconPosition === 'start' && !fluidWidth
+      ? {
+          small: {
+            paddingInlineStart: `calc(${componentTheme.contentPaddingSmall} + ${componentTheme.togglePadding})`,
+            paddingInlineEnd: '0'
+          },
+          medium: {
+            paddingInlineStart: `calc(${componentTheme.contentPaddingMedium} + ${componentTheme.togglePadding})`,
+            paddingInlineEnd: '0'
+          },
+          large: {
+            paddingInlineStart: `calc(${componentTheme.contentPaddingLarge} + ${componentTheme.togglePadding})`,
+            paddingInlineEnd: '0'
+          }
+        }
+      : {
+          small: {},
+          medium: {},
+          large: {}
+        }
+
+  return {
+    toggleDetails: {
+      label: 'toggleDetails',
+      fontFamily: componentTheme.fontFamily,
+      fontWeight: componentTheme.fontWeight
+    },
+    summary: {
+      label: 'toggleDetails__summary',
+      position: 'relative',
+      display: 'flex',
+      alignItems: 'center',
+      boxSizing: 'border-box',
+      textAlign: 'start'
+    },
+    summaryText: {
+      label: 'toggleDetails__summaryText',
+      minWidth: '0.0625rem',
+      flexGrow: 1,
+      ...(positionIconAtEnd ? { flex: 1 } : {})
+    },
+    toggle: {
+      label: 'toggleDetails__toggle',
+      fontFamily: componentTheme.fontFamily,
+      lineHeight: componentTheme.lineHeight,
+      appearance: 'none',
+      cursor: 'pointer',
+      userSelect: 'none',
+      touchAction: 'manipulation',
+      position: 'relative',
+      overflow: 'visible',
+      boxSizing: 'border-box',
+      padding: '0',
+      margin: '0',
+      outline: 'none',
+      border: 'none',
+      background: 'transparent',
+      color: componentTheme.textColor,
+      '&::-moz-focus-inner': { padding: '0', margin: '0' },
+      '&::before': {
+        content: '""',
+        position: 'absolute',
+        top: '-0.375rem',
+        left: '-0.375rem',
+        right: '-0.375rem',
+        bottom: '-0.375rem',
+        border: `${componentTheme.toggleBorderWidth} ${componentTheme.toggleBorderStyle} ${sharedTokens.focusOutline.infoColor}`,
+        borderRadius: `calc(${componentTheme.toggleBorderRadius} * 1.5)`,
+        opacity: 0,
+        pointerEvents: 'none'
+      },
+      '&:focus': { '&::before': { opacity: 1 } },
+      '&:focus, &:hover,  &:active': {
+        textDecoration: 'none',
+        color: componentTheme.textColor
+      },
+      textDecoration: 'none',
+      ...fluidWidthStyles,
+      ...fontSizeStyles[size!]
+    },
+    icon: {
+      label: 'toggleDetails__icon',
+      display: 'flex',
+      alignItems: 'center',
+      '& > svg': {
+        display: 'block' /* fix vertical alignment of icon */
+      },
+      ...iconPositionStyles[iconPosition!]
+    },
+    details: {
+      label: 'toggleDetails__details',
+      boxSizing: 'border-box',
+      paddingTop: componentTheme.togglePadding,
+      color: componentTheme.textColor,
+      lineHeight: componentTheme.lineHeight,
+      ...fontSizeStyles[size!],
+      ...indentDetailsStyles[size!]
+    },
+    content: {
+      label: 'toggleDetails__content',
+      opacity: 0.01,
+      animationName: contentAnimation,
+      animationFillMode: 'forwards',
+      animationDuration: '.3s'
+    }
+  }
+}
+
+export default generateStyle

package/src/ToggleGroup/{index.tsx → v1/index.tsx}

@@ -30,13 +30,13 @@ import {
   getElementType,
   callRenderProp
 } from '@instructure/ui-react-utils'
-import { IconButton } from '@instructure/ui-buttons'
+import { IconButton } from '@instructure/ui-buttons/v11_6'
 import { Transition } from '@instructure/ui-motion'
 import { Expandable } from '@instructure/ui-expandable'
 import type { ExpandableToggleProps } from '@instructure/ui-expandable'
 import { isActiveElement } from '@instructure/ui-dom-utils'
-import { Flex } from '@instructure/ui-flex'
-import { View } from '@instructure/ui-view'
+import { Flex } from '@instructure/ui-flex/v11_6'
+import { View } from '@instructure/ui-view/v11_6'
 import {
   IconArrowOpenEndSolid,
   IconArrowOpenDownSolid
@@ -44,7 +44,7 @@ import {
 import type { ToggleGroupProps } from './props'
 import { allowedProps } from './props'
 
-import { withStyle } from '@instructure/emotion'
+import { withStyleLegacy as withStyle } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'

package/src/ToggleGroup/v2/README.md

@@ -0,0 +1,93 @@
+---
+describes: ToggleGroup
+---
+
+Performs the same function as [`ToggleDetails`](ToggleDetails), but with the summary separated from the
+toggle button, and built in padding and borders around the summary and main content area.
+
+### Basic example
+
+```javascript
+---
+type: example
+---
+<ToggleGroup
+  toggleLabel="This is the toggle button label for screenreaders"
+  summary="This is the summary"
+  background="default"
+>
+  <View display="block" padding="small">Here is the expanded content</View>
+</ToggleGroup>
+```
+
+### More detailed examples
+
+#### `defaultExpanded` to make the component `expanded` when it renders
+
+```javascript
+---
+type: example
+---
+<ToggleGroup
+  toggleLabel="This is the toggle button label for screenreaders"
+  summary="This is the summary"
+  defaultExpanded
+>
+  <View display="block" padding="small">This content is expanded when the component renders</View>
+</ToggleGroup>
+```
+
+#### Passing in your own `icon` and `iconExpanded`
+
+```javascript
+---
+type: example
+---
+<ToggleGroup
+  toggleLabel="This is the toggle button label for screenreaders"
+  summary="This is the summary"
+  iconExpanded={XInstUIIcon}
+  icon={PlusInstUIIcon}
+>
+  <View display="block" padding="small">Here is the expanded content</View>
+</ToggleGroup>
+```
+
+#### Disable default transition of details
+
+```javascript
+---
+type: example
+---
+<ToggleGroup
+  transition={false}
+  toggleLabel="This is the toggle button label for screenreaders"
+  summary="This is the summary"
+>
+  <View display="block" padding="small">This content will not fade in</View>
+</ToggleGroup>
+```
+
+#### Disable default border if you want to nest ToggleGroups
+
+```javascript
+---
+type: example
+---
+<ToggleGroup
+  defaultExpanded
+  toggleLabel="This is the toggle button label for screenreaders"
+  summary={<Heading level="h3">Parent ToggleGroup</Heading>}
+>
+  <ToggleGroup
+    size="small"
+    toggleLabel="This is the toggle button label for screenreaders"
+    summary="I am nested inside a parent ToggleGroup"
+    border={false}
+  >
+    <View display="block" padding="small">
+      This is the details section of the nested ToggleGroup
+    </View>
+  </ToggleGroup>
+</ToggleGroup>
+```