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

package/lib/Text/v2/styles.js

@@ -0,0 +1,278 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/*
+ * 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.
+ */
+
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param componentTheme The theme variable object.
+ * @param params Additional parameters to customize the style.
+ * @return The final style object, which will be used in the component
+ */
+const generateStyle = (componentTheme, params) => {
+  const color = params.color,
+    fontStyle = params.fontStyle,
+    lineHeight = params.lineHeight,
+    letterSpacing = params.letterSpacing,
+    transform = params.transform,
+    size = params.size,
+    variant = params.variant,
+    weight = params.weight,
+    wrap = params.wrap;
+  const variants = {
+    descriptionPage: {
+      fontFamily: componentTheme.descriptionPage.fontFamily,
+      fontWeight: componentTheme.descriptionPage.fontWeight,
+      fontSize: componentTheme.descriptionPage.fontSize,
+      lineHeight: componentTheme.descriptionPage.lineHeight
+    },
+    descriptionSection: {
+      fontFamily: componentTheme.descriptionSection.fontFamily,
+      fontWeight: componentTheme.descriptionSection.fontWeight,
+      fontSize: componentTheme.descriptionSection.fontSize,
+      lineHeight: componentTheme.descriptionSection.lineHeight
+    },
+    content: {
+      fontFamily: componentTheme.content.fontFamily,
+      fontWeight: componentTheme.content.fontWeight,
+      fontSize: componentTheme.content.fontSize,
+      lineHeight: componentTheme.content.lineHeight
+    },
+    contentImportant: {
+      fontFamily: componentTheme.contentImportant.fontFamily,
+      fontWeight: componentTheme.contentImportant.fontWeight,
+      fontSize: componentTheme.contentImportant.fontSize,
+      lineHeight: componentTheme.contentImportant.lineHeight
+    },
+    contentQuote: {
+      fontFamily: componentTheme.contentQuote.fontFamily,
+      fontWeight: componentTheme.contentQuote.fontWeight,
+      fontSize: componentTheme.contentQuote.fontSize,
+      lineHeight: componentTheme.contentQuote.lineHeight
+    },
+    contentSmall: {
+      fontFamily: componentTheme.contentSmall.fontFamily,
+      fontWeight: componentTheme.contentSmall.fontWeight,
+      fontSize: componentTheme.contentSmall.fontSize,
+      lineHeight: componentTheme.contentSmall.lineHeight
+    },
+    legend: {
+      fontFamily: componentTheme.legend.fontFamily,
+      fontWeight: componentTheme.legend.fontWeight,
+      fontSize: componentTheme.legend.fontSize,
+      lineHeight: componentTheme.legend.lineHeight
+    }
+  };
+  const colorVariants = {
+    primary: {
+      color: componentTheme.baseColor
+    },
+    secondary: {
+      color: componentTheme.mutedColor
+    },
+    'primary-inverse': {
+      color: componentTheme.inverseColor
+    },
+    'secondary-inverse': {
+      color: componentTheme.inverseColor
+    },
+    success: {
+      color: componentTheme.successColor
+    },
+    brand: {
+      color: componentTheme.primaryColor
+    },
+    danger: {
+      color: componentTheme.errorColor
+    },
+    warning: {
+      color: componentTheme.warningColor
+    },
+    'primary-on': {
+      color: componentTheme.baseOnColor
+    },
+    'secondary-on': {
+      color: componentTheme.mutedOnColor
+    },
+    'ai-highlight': {
+      color: componentTheme.aiColor,
+      background: componentTheme.aiBackgroundColor
+    }
+  };
+  const wrapStyle = {
+    overflowWrap: 'break-word',
+    wordBreak: 'break-word',
+    hyphens: 'auto'
+  };
+  const weightStyle = {
+    normal: {
+      fontWeight: componentTheme.fontWeightNormal
+    },
+    light: {
+      fontWeight: componentTheme.fontWeightLight
+    },
+    bold: {
+      fontWeight: componentTheme.fontWeightBold
+    },
+    weightRegular: {
+      fontWeight: componentTheme.fontWeightRegular
+    },
+    weightImportant: {
+      fontWeight: componentTheme.fontWeightImportant
+    }
+  };
+  const fontSizeVariants = {
+    'x-small': componentTheme.fontSizeXSmall,
+    small: componentTheme.fontSizeSmall,
+    medium: componentTheme.fontSizeMedium,
+    large: componentTheme.fontSizeLarge,
+    'x-large': componentTheme.fontSizeXLarge,
+    'xx-large': componentTheme.fontSizeXXLarge,
+    // these are deprecated
+    descriptionPage: componentTheme.descriptionPage.fontSize,
+    descriptionSection: componentTheme.descriptionSection.fontSize,
+    content: componentTheme.content.fontSize,
+    contentSmall: componentTheme.contentSmall.fontSize,
+    legend: componentTheme.legend.fontSize
+  };
+  const lineHeightVariants = {
+    default: {
+      lineHeight: componentTheme.lineHeight
+    },
+    fit: {
+      lineHeight: componentTheme.lineHeightFit
+    },
+    condensed: {
+      lineHeight: componentTheme.lineHeightCondensed
+    },
+    double: {
+      lineHeight: componentTheme.lineHeightDouble
+    },
+    lineHeight100: {
+      lineHeight: componentTheme.lineHeight100
+    },
+    lineHeight125: {
+      lineHeight: componentTheme.lineHeight125
+    },
+    lineHeight150: {
+      lineHeight: componentTheme.lineHeight150
+    }
+  };
+  const letterSpacingVariants = {
+    normal: componentTheme.letterSpacingNormal,
+    condensed: componentTheme.letterSpacingCondensed,
+    expanded: componentTheme.letterSpacingExpanded
+  };
+  const calcTextStyles = () => {
+    if (variant) {
+      return variants[variant];
+    }
+    return {
+      ...(weight ? weightStyle[weight] : {}),
+      ...(fontStyle ? {
+        fontStyle: fontStyle
+      } : {}),
+      fontSize: fontSizeVariants[size],
+      ...(lineHeight ? lineHeightVariants[lineHeight] : {})
+    };
+  };
+  const baseStyles = {
+    '&:focus': {
+      outline: 'none'
+    },
+    ...(color ? colorVariants[color] : {
+      color: componentTheme.baseColor
+    }),
+    ...(wrap === 'break-word' ? wrapStyle : {}),
+    letterSpacing: letterSpacingVariants[letterSpacing],
+    ...(transform ? {
+      textTransform: transform
+    } : {}),
+    ...calcTextStyles()
+  };
+  const inputStyles = {
+    ...baseStyles,
+    outline: 0,
+    appearance: 'none',
+    boxSizing: 'border-box',
+    background: 'none',
+    border: 'none',
+    borderRadius: 0,
+    padding: 0,
+    margin: 0,
+    color: 'inherit',
+    height: 'auto',
+    width: '100%',
+    lineHeight: 'inherit',
+    textAlign: 'start',
+    boxShadow: 'none',
+    display: 'block'
+  };
+  return {
+    text: {
+      label: 'text',
+      fontFamily: componentTheme.fontFamily,
+      ...baseStyles,
+      // NOTE: needs separate groups for `:is()` and `:-webkit-any()` because
+      // of css selector group validation (see https://www.w3.org/TR/selectors-3/#grouping)
+      '&:is(input)[type]': inputStyles,
+      '&:-webkit-any(input)[type]': inputStyles,
+      'sub, sup': {
+        fontSize: '75%',
+        lineHeight: 0,
+        position: 'relative',
+        verticalAlign: 'baseline'
+      },
+      sup: {
+        top: '-0.4em'
+      },
+      sub: {
+        bottom: '-0.4em'
+      },
+      'pre, code': {
+        all: 'initial',
+        fontFamily: componentTheme.fontFamilyMonospace
+      },
+      'i, em': {
+        fontStyle: 'italic'
+      },
+      'b, strong': {
+        fontWeight: componentTheme.fontWeightBold
+      },
+      p: {
+        display: 'block',
+        padding: 0,
+        margin: componentTheme.paragraphMargin
+      }
+    }
+  };
+};
+var _default = exports.default = generateStyle;

package/lib/{index.js → exports/a.js}

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "Text", {
   enumerable: true,
   get: function () {
-    return _Text.Text;
+    return _v.Text;
   }
 });
-var _Text = require("./Text");
+var _v = require("../Text/v1");

package/lib/exports/b.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Text", {
+  enumerable: true,
+  get: function () {
+    return _v.Text;
+  }
+});
+var _v = require("../Text/v2");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-text",
-  "version": "11.6.0",
+  "version": "11.6.1-snapshot-129",
   "description": "A component for styling textual content",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -15,18 +15,18 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.27.6",
-    "@instructure/console": "11.6.0",
-    "@instructure/emotion": "11.6.0",
-    "@instructure/shared-types": "11.6.0",
-    "@instructure/ui-color-utils": "11.6.0",
-    "@instructure/ui-react-utils": "11.6.0"
+    "@instructure/console": "11.6.1-snapshot-129",
+    "@instructure/emotion": "11.6.1-snapshot-129",
+    "@instructure/ui-react-utils": "11.6.1-snapshot-129",
+    "@instructure/ui-color-utils": "11.6.1-snapshot-129",
+    "@instructure/shared-types": "11.6.1-snapshot-129"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "15.0.7",
-    "@instructure/ui-axe-check": "11.6.0",
-    "@instructure/ui-babel-preset": "11.6.0",
-    "@instructure/ui-themes": "11.6.0"
+    "@instructure/ui-babel-preset": "11.6.1-snapshot-129",
+    "@instructure/ui-themes": "11.6.1-snapshot-129",
+    "@instructure/ui-axe-check": "11.6.1-snapshot-129"
   },
   "peerDependencies": {
     "react": ">=18 <=19"
@@ -36,17 +36,39 @@
   },
   "sideEffects": false,
   "exports": {
-    ".": {
-      "types": "./types/index.d.ts",
-      "import": "./es/index.js",
-      "require": "./lib/index.js",
-      "default": "./es/index.js"
-    },
     "./lib/*": "./lib/*",
     "./es/*": "./es/*",
     "./types/*": "./types/*",
     "./package.json": "./package.json",
-    "./src/*": "./src/*"
+    "./src/*": "./src/*",
+    ".": {
+      "src": "./src/exports/a.ts",
+      "types": "./types/exports/a.d.ts",
+      "import": "./es/exports/a.js",
+      "require": "./lib/exports/a.js",
+      "default": "./es/exports/a.js"
+    },
+    "./v11_6": {
+      "src": "./src/exports/a.ts",
+      "types": "./types/exports/a.d.ts",
+      "import": "./es/exports/a.js",
+      "require": "./lib/exports/a.js",
+      "default": "./es/exports/a.js"
+    },
+    "./v11_7": {
+      "src": "./src/exports/b.ts",
+      "types": "./types/exports/b.d.ts",
+      "import": "./es/exports/b.js",
+      "require": "./lib/exports/b.js",
+      "default": "./es/exports/b.js"
+    },
+    "./latest": {
+      "src": "./src/exports/b.ts",
+      "types": "./types/exports/b.d.ts",
+      "import": "./es/exports/b.js",
+      "require": "./lib/exports/b.js",
+      "default": "./es/exports/b.js"
+    }
   },
   "scripts": {
     "lint": "ui-scripts lint",

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

@@ -26,7 +26,7 @@ import { Component } from 'react'
 
 import { passthroughProps, getElementType } from '@instructure/ui-react-utils'
 
-import { withStyle } from '@instructure/emotion'
+import { withStyleLegacy as withStyle } from '@instructure/emotion'
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
 import type { TextProps } from './props'

package/src/Text/v2/README.md

@@ -0,0 +1,200 @@
+---
+describes: Text
+---
+
+A component for styling textual content
+
+## Variant
+
+Variant takes care of - almost - all use-cases when it comes to texts on pages. Their name reflects the places they meant to be used. It sets `font family`, `size`, `weight` and `lineHeight`.
+
+> We recommend using `variant` instead of setting values directly.
+
+NOTE: when `variant` is set, `size`, `weight`, `fontStyle` and `lineHeight` props are ignored
+
+```js
+---
+type: example
+---
+<div>
+  <Text variant="descriptionPage"> descriptionPage </Text><br/>
+  <Text variant="descriptionSection"> descriptionSection </Text><br/>
+  <Text variant="content"> content </Text><br/>
+  <Text variant="contentImportant"> contentImportant </Text><br/>
+  <Text variant="contentQuote"> contentQuote </Text><br/>
+  <Text variant="contentSmall"> contentSmall </Text><br/>
+  <Text variant="legend"> legend </Text><br/>
+</div>
+```
+
+### Text colors
+
+```js
+---
+type: example
+---
+<div>
+  <Text color="primary">I&#39;m primary text</Text><br/>
+  <Text color="secondary">I&#39;m secondary text</Text><br/>
+  <Text color="brand">I&#39;m brand text</Text><br />
+  <Text color="success">I&#39;m success text</Text><br/>
+  <Text color="warning">I&#39;m warning text</Text><br />
+  <Text color="danger">I&#39;m danger text</Text><br />
+  <Text color="ai-highlight">I&#39;m an ai-highlight text</Text><br />
+  <View background="primary-inverse">
+    <Text color="primary-inverse">I&#39;m primary-inverse text</Text><br />
+    <Text color="secondary-inverse">I&#39;m secondary-inverse text</Text><br />
+  </View>
+  <View background="success">
+    <Text color="primary-on">I&#39;m primary-on text</Text><br />
+    <Text color="secondary-on">I&#39;m secondary-on text</Text><br />
+  </View>
+</div>
+```
+
+### Font sizes
+
+```js
+---
+type: example
+---
+<div>
+  <Text size='x-small'>x-small</Text><br/>
+  <Text size='small'>small</Text><br/>
+  <Text size='medium'>medium</Text><br/>
+  <Text size='large'>large</Text><br/>
+  <Text size='x-large'>x-large</Text><br/>
+  <Text size='xx-large'>xx-large</Text>
+</div>
+```
+
+### Font weights
+
+```js
+---
+type: example
+---
+<div>
+  <Text weight="light">light text</Text><br/>
+  <Text weight="normal">normal text</Text><br/>
+  <Text weight="bold">bold text</Text>
+</div>
+```
+
+### Font styles
+
+```js
+---
+type: example
+---
+<div>
+  <Text fontStyle="italic">I&#39;m italic text</Text><br/>
+  <Text>I&#39;m normal text</Text>
+</div>
+```
+
+### Line heights
+
+```js
+---
+type: example
+---
+<div>
+  <Text lineHeight="default">
+    <p><b>default:</b> {lorem.paragraph()}</p>
+  </Text>
+  <Text lineHeight="fit">
+    <p><b>fit:</b> {lorem.paragraph()}</p>
+  </Text>
+  <Text lineHeight="condensed">
+    <p><b>condensed:</b> {lorem.paragraph()}</p>
+  </Text>
+  <Text lineHeight="double">
+    <p><b>double:</b> {lorem.paragraph()}</p>
+  </Text>
+</div>
+```
+
+### Text transformations
+
+```js
+---
+type: example
+---
+<div>
+  <Text transform="capitalize">I&#39;m capitalized text</Text><br/>
+  <Text transform="uppercase">I&#39;m uppercase text</Text><br/>
+  <Text transform="lowercase">I&#39;M LOWERCASE TEXT</Text><br/>
+</div>
+```
+
+### Letter-spacing
+
+```js
+---
+type: example
+---
+<div>
+  <Text letterSpacing="normal">I&#39;m normal text</Text><br/>
+  <Text letterSpacing="condensed">I&#39;m condensed text</Text><br/>
+  <Text letterSpacing="expanded" transform="uppercase">I&#39;m expanded uppercase text</Text><br/>
+</div>
+```
+
+### Wrap
+
+Use `wrap="break-word"` to force breaking in long strings that would otherwise
+exceed the bounds of their containers.
+
+```js
+---
+type: example
+---
+<div>
+  <View as="div" maxWidth="300px" margin="none none small" debug>
+    <Text>
+      superlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstring
+    </Text>
+  </View>
+  <View as="div" maxWidth="300px" debug>
+    <Text wrap="break-word">
+      superlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstringsuperlongstring
+    </Text>
+  </View>
+</div>
+```
+
+### Element styles
+
+You can use simple HTML tags to style your text.
+
+```js
+---
+type: example
+---
+<Text>
+  <b>bold </b>
+  <strong>strong </strong>
+  <i>italic </i>
+  <em>emphasis </em>
+  <pre>preformatted </pre>
+  <code>code </code><br/>
+  This <sup>sup</sup> normal <sub>sub </sub> text.
+</Text>
+```
+
+### DEPRECATED legacy values
+
+Multiple values from `size`, `weight` and `lineHeight` are deprecated, but still supported for backward compatibility reasons. Please only use the above listed, semantic values.
+
+Deprecated `size` values:
+
+`descriptionPage`, `descriptionSection`, `content`, `contentSmall`, `legend`
+
+Deprecated `weight` values:
+
+`weightRegular`, `weightImportant`
+
+Deprecated `lineHeight` values:
+
+`lineHeight100`, `lineHeight125`, `lineHeight150`

package/src/Text/v2/index.tsx

@@ -0,0 +1,106 @@
+/*
+ * 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 } from 'react'
+
+import { passthroughProps, getElementType } from '@instructure/ui-react-utils'
+
+import { withStyle } from '@instructure/emotion'
+import generateStyle from './styles'
+import type { TextProps } from './props'
+import { allowedProps } from './props'
+
+/**
+---
+category: components
+---
+**/
+@withStyle(generateStyle)
+class Text extends Component<TextProps> {
+  static readonly componentId = 'Text'
+
+  static allowedProps = allowedProps
+
+  static defaultProps = {
+    as: 'span',
+    wrap: 'normal',
+    size: 'medium',
+    letterSpacing: 'normal',
+    children: null
+  } as const
+
+  ref: Element | null = null
+
+  handleRef = (el: Element | null) => {
+    this.ref = el
+    const { elementRef } = this.props
+    if (typeof elementRef === 'function') {
+      elementRef(el)
+    }
+  }
+
+  checkProps() {
+    const { variant, lineHeight, weight, fontStyle } = this.props
+    if (variant) {
+      if (lineHeight) {
+        console.warn("[Text]: Don't use 'lineHeight' with 'variant' ")
+      }
+      if (weight) {
+        console.warn("[Text]: Don't use 'weight' with 'variant' ")
+      }
+      if (fontStyle) {
+        console.warn("[Text]: Don't use 'fontStyle' with 'variant' ")
+      }
+    }
+  }
+
+  componentDidMount() {
+    this.props.makeStyles?.()
+    this.checkProps()
+  }
+
+  componentDidUpdate() {
+    this.props.makeStyles?.()
+    this.checkProps()
+  }
+
+  render() {
+    const { children } = this.props
+
+    const ElementType = getElementType(Text, this.props)
+
+    return (
+      <ElementType
+        {...passthroughProps(this.props)}
+        css={this.props.styles?.text}
+        ref={this.handleRef}
+      >
+        {children}
+      </ElementType>
+    )
+  }
+}
+
+export default Text
+export { Text }