@ohos-ports/instructure-ui-toggle-details 11.7.5-beta.1

package/LICENSE.md

@@ -0,0 +1,28 @@
+---
+title: The MIT License (MIT)
+category: Getting Started
+order: 9
+isWIP: true
+---
+
+# The MIT License (MIT)
+
+Copyright (c) 2015 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.

package/README.md

@@ -0,0 +1,42 @@
+## ui-toggle-details
+
+[![npm][npm]][npm-url]
+[![MIT License][license-badge]][license]
+[![Code of Conduct][coc-badge]][coc]
+
+A styled toggleable, accordion-like component.
+
+### Components
+
+The `ui-toggle-details` package contains the following:
+
+- [ToggleDetails](ToggleDetails)
+- [ToggleGroup](ToggleGroup)
+
+### Installation
+
+```sh
+npm install @instructure/ui-toggle-details
+```
+
+### Usage
+
+```js
+import React from 'react'
+import { ToggleDetails } from '@instructure/ui-toggle-details'
+
+const MyToggleDetails = () => {
+  return (
+    <ToggleDetails summary="Hello toggle">
+      <Text>Hello details</Text>
+    </ToggleDetails>
+  )
+}
+```
+
+[npm]: https://img.shields.io/npm/v/@instructure/ui-toggle-details.svg
+[npm-url]: https://npmjs.com/package/@instructure/ui-toggle-details
+[license-badge]: https://img.shields.io/npm/l/instructure-ui.svg?style=flat-square
+[license]: https://github.com/instructure/instructure-ui/blob/master/LICENSE.md
+[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
+[coc]: https://github.com/instructure/instructure-ui/blob/master/CODE_OF_CONDUCT.md

package/es/ToggleDetails/v1/index.js

@@ -0,0 +1,177 @@
+var _dec, _class;
+/*
+ * 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/v11_6';
+import { IconArrowOpenEndSolid, IconArrowOpenDownSolid } 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.js';
+import generateComponentTheme from './theme.js';
+import { allowedProps } from './props.js';
+import { jsx as _jsx, jsxs as _jsxs } from "@emotion/react/jsx-runtime";
+/**
+---
+category: components
+---
+**/
+let ToggleDetails = (_dec = withStyle(generateStyle, generateComponentTheme), _dec(_class = class ToggleDetails extends Component {
+  static displayName = 'ToggleDetails';
+  static componentId = 'ToggleDetails';
+  static allowedProps = allowedProps;
+  static defaultProps = {
+    variant: 'default',
+    size: 'medium',
+    fluidWidth: false,
+    icon: IconArrowOpenEndSolid,
+    iconExpanded: IconArrowOpenDownSolid,
+    iconPosition: 'start',
+    defaultExpanded: false,
+    children: null
+  };
+  _buttonNode = null;
+  ref = /*#__PURE__*/createRef();
+
+  // TODO this solution was generated with Gemini, should be tested if it works as fine as before
+  setButtonRef = node => {
+    this._buttonNode = node;
+  };
+  get focused() {
+    return isActiveElement(this._buttonNode);
+  }
+  focus() {
+    this._buttonNode?.focus();
+  }
+  componentDidMount() {
+    this.props.makeStyles?.();
+  }
+  componentDidUpdate() {
+    this.props.makeStyles?.();
+  }
+  renderSummary(expanded) {
+    const {
+      summary,
+      iconPosition
+    } = this.props;
+    return _jsxs("span", {
+      css: this.props.styles?.summary,
+      children: [iconPosition === 'start' && this.renderIcon(expanded), _jsx("span", {
+        css: this.props.styles?.summaryText,
+        children: summary
+      }), iconPosition === 'end' && this.renderIcon(expanded)]
+    });
+  }
+  renderToggle(toggleProps, expanded) {
+    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)
+    };
+    const summary = this.renderSummary(expanded);
+    if (variant === 'filled') {
+      return _jsx(Button, {
+        ...props,
+        display: "block",
+        textAlign: "start",
+        elementRef: this.setButtonRef,
+        children: summary
+      });
+    } else if (props.href) {
+      return _jsx("a", {
+        ...props,
+        css: this.props.styles?.toggle,
+        ref: this.setButtonRef,
+        children: summary
+      });
+    } else {
+      return _jsx("button", {
+        ...props,
+        type: "button",
+        css: this.props.styles?.toggle,
+        ref: this.setButtonRef,
+        children: summary
+      });
+    }
+  }
+  renderIcon(expanded) {
+    const Icon = expanded ? this.props.iconExpanded : this.props.icon;
+    return this.props.children && Icon ? _jsx("span", {
+      css: this.props.styles?.icon,
+      children: _jsx(Icon, {})
+    }) : null;
+  }
+  renderDetails(expanded, detailsProps) {
+    if (!this.props.children) return null;
+    const expandedStyles = expanded ? {
+      display: 'block'
+    } : {
+      display: 'none'
+    };
+    return _jsx("div", {
+      ...detailsProps,
+      css: [this.props.styles?.details, expandedStyles],
+      children: expanded && this.renderContent()
+    });
+  }
+  renderContent() {
+    return _jsx("div", {
+      css: this.props.styles?.content,
+      children: this.props.children
+    });
+  }
+  handleToggle = (event, expanded) => {
+    if (typeof this.props.onToggle === 'function') {
+      this.props.onToggle(event, expanded);
+    }
+  };
+  render() {
+    return _jsx(Expandable, {
+      ...pickProps(this.props, Expandable.allowedProps),
+      onToggle: this.handleToggle,
+      children: ({
+        expanded,
+        getToggleProps,
+        getDetailsProps
+      }) => {
+        return _jsxs("div", {
+          css: this.props.styles?.toggleDetails,
+          ref: this.ref,
+          "data-cid": "ToggleDetails",
+          children: [this.renderToggle(getToggleProps(), expanded), this.renderDetails(expanded, getDetailsProps())]
+        });
+      }
+    });
+  }
+}) || _class);
+export default ToggleDetails;
+export { ToggleDetails };

package/es/ToggleDetails/v1/props.js

@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+
+const allowedProps = ['variant', 'summary', 'expanded', 'defaultExpanded', 'onToggle', 'icon', 'iconExpanded', 'iconPosition', 'fluidWidth', 'children', 'size'];
+export { allowedProps };

package/es/ToggleDetails/v1/styles.js

@@ -0,0 +1,196 @@
+/*
+ * 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';
+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} 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 {
+    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 iconSizeStyles = {
+    small: {
+      fontSize: componentTheme.smallIconSize
+    },
+    medium: {
+      fontSize: componentTheme.mediumIconSize
+    },
+    large: {
+      fontSize: componentTheme.largeIconSize
+    }
+  };
+  const indentDetailsStyles = iconPosition === 'start' && !fluidWidth ? {
+    small: {
+      paddingInlineStart: `calc(${componentTheme.smallIconSize} + ${componentTheme.togglePadding})`,
+      paddingInlineEnd: '0'
+    },
+    medium: {
+      paddingInlineStart: `calc(${componentTheme.mediumIconSize} + ${componentTheme.togglePadding})`,
+      paddingInlineEnd: '0'
+    },
+    large: {
+      paddingInlineStart: `calc(${componentTheme.largeIconSize} + ${componentTheme.togglePadding})`,
+      paddingInlineEnd: '0'
+    }
+  } : {
+    small: {},
+    medium: {},
+    large: {}
+  };
+  return {
+    toggleDetails: {
+      label: 'toggleDetails',
+      fontFamily: componentTheme.fontFamily,
+      fontWeight: componentTheme.fontWeight,
+      lineHeight: componentTheme.lineHeight
+    },
+    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,
+      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} ${componentTheme.toggleFocusBorderColor}`,
+        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',
+      '& > svg': {
+        display: 'block' /* fix vertical alignment of icon */
+      },
+      ...iconPositionStyles[iconPosition],
+      ...iconSizeStyles[size]
+    },
+    details: {
+      label: 'toggleDetails__details',
+      boxSizing: 'border-box',
+      paddingTop: componentTheme.togglePadding,
+      color: componentTheme.textColor,
+      ...fontSizeStyles[size],
+      ...indentDetailsStyles[size]
+    },
+    content: {
+      label: 'toggleDetails__content',
+      opacity: 0.01,
+      animationName: contentAnimation,
+      animationFillMode: 'forwards',
+      animationDuration: '.3s'
+    }
+  };
+};
+export default generateStyle;

package/es/ToggleDetails/v1/theme.js

@@ -0,0 +1,75 @@
+/*
+ * 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 {
+    colors,
+    spacing,
+    borders,
+    typography,
+    key: themeName
+  } = theme;
+  const themeSpecificStyle = {
+    canvas: {
+      toggleFocusBorderColor: theme['ic-brand-primary'],
+      iconColor: theme['ic-brand-font-color-dark'],
+      textColor: theme['ic-brand-font-color-dark']
+    }
+  };
+  const componentVariables = {
+    fontFamily: typography?.fontFamily,
+    fontWeight: typography?.fontWeightNormal,
+    lineHeight: typography?.lineHeight,
+    textColor: colors?.contrasts?.grey125125,
+    fontSizeSmall: typography?.fontSizeSmall,
+    fontSizeMedium: typography?.fontSizeMedium,
+    fontSizeLarge: typography?.fontSizeLarge,
+    smallIconSize: '0.5rem',
+    mediumIconSize: '0.75rem',
+    largeIconSize: '1rem',
+    iconMargin: spacing?.xxSmall,
+    iconColor: colors?.contrasts?.grey125125,
+    togglePadding: spacing?.xxSmall,
+    toggleBorderRadius: borders?.radiusMedium,
+    toggleBorderWidth: borders?.widthMedium,
+    toggleBorderStyle: borders?.style,
+    toggleFocusBorderColor: colors?.contrasts?.blue4570,
+    filledBackgroundColor: colors?.contrasts?.grey1111,
+    filledBorderWidth: borders?.widthSmall,
+    filledBorderStyle: borders?.style,
+    filledBorderColor: colors?.contrasts?.grey1424,
+    filledBorderRadius: borders?.radiusMedium,
+    filledPadding: spacing?.small
+  };
+  return {
+    ...componentVariables,
+    ...themeSpecificStyle[themeName]
+  };
+};
+export default generateComponentTheme;