@tds/core-text - npm Package Compare versions

Comparing version 1.0.11 to 1.1.0

CHANGELOG.md

@@ -6,10 +6,12 @@ # Change Log
 
-## [1.0.11](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.10...@tds/core-text@1.0.11) (2019-05-01)
+# [1.1.0](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.11...@tds/core-text@1.1.0) (2019-06-04)
 
-**Note:** Version bump only for package @tds/core-text
+### Features
 
+- **core-text:** add sup tag support ([e4df9d6](https://github.com/telusdigital/tds/commit/e4df9d6)), closes [#1059](https://github.com/telusdigital/tds/issues/1059)
 
+## [1.0.11](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.10...@tds/core-text@1.0.11) (2019-05-01)
 
+**Note:** Version bump only for package @tds/core-text
 
-
 ## [1.0.10](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.9...@tds/core-text@1.0.10) (2019-03-28)
@@ -19,6 +21,2 @@
 
-
-
-
-
 ## [1.0.9](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.8...@tds/core-text@1.0.9) (2019-03-20)
@@ -28,6 +26,2 @@
 
-
-
-
-
 ## [1.0.8](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.7...@tds/core-text@1.0.8) (2019-03-20)
@@ -37,6 +31,2 @@
 
-
-
-
-
 ## [1.0.7](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.6...@tds/core-text@1.0.7) (2019-03-18)
@@ -46,6 +36,2 @@
 
-
-
-
-
 ## [1.0.6](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.5...@tds/core-text@1.0.6) (2019-03-05)
@@ -55,6 +41,2 @@
 
-
-
-
-
 ## [1.0.5](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.4...@tds/core-text@1.0.5) (2019-02-06)
@@ -64,39 +46,26 @@
 
+<a name="1.0.4"></a>
 
-
-
-
-<a name="1.0.4"></a>
 ## [1.0.4](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.3...@tds/core-text@1.0.4) (2018-12-19)
 
-
 ### Bug Fixes
 
-* **core-text:** modify block prop behaviour ([c2f37a6](https://github.com/telusdigital/tds/commit/c2f37a6))
+- **core-text:** modify block prop behaviour ([c2f37a6](https://github.com/telusdigital/tds/commit/c2f37a6))
 
+<a name="1.0.3"></a>
 
-
-
-<a name="1.0.3"></a>
 ## [1.0.3](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.2...@tds/core-text@1.0.3) (2018-12-06)
 
-
-
-
 **Note:** Version bump only for package @tds/core-text
 
 <a name="1.0.2"></a>
+
 ## [1.0.2](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.1...@tds/core-text@1.0.2) (2018-07-10)
 
-
-
-
 **Note:** Version bump only for package @tds/core-text
 
 <a name="1.0.1"></a>
+
 ## [1.0.1](https://github.com/telusdigital/tds/compare/@tds/core-text@1.0.0...@tds/core-text@1.0.1) (2018-06-14)
 
-
-
-
 **Note:** Version bump only for package @tds/core-text

dist/index.cjs.js

@@ -72,3 +72,3 @@ 'use strict';
 
-var styles = {"wordBreak":"TDS_Typography-modules__wordBreak___3OZx_","baseSupSubScripts":"TDS_Typography-modules__baseSupSubScripts___WeebJ","sup":"TDS_Typography-modules__sup___3IauS TDS_Typography-modules__baseSupSubScripts___WeebJ","base":"TDS_Typography-modules__base___2nkPE TDS_Typography-modules__wordBreak___3OZx_","baseFont":"TDS_Typography-modules__baseFont___2Cfk4","small":"TDS_Typography-modules__small___mt5lS TDS_Typography-modules__wordBreak___3OZx_","smallFont":"TDS_Typography-modules__smallFont___3S6nz","medium":"TDS_Typography-modules__medium___1rxfE TDS_Typography-modules__wordBreak___3OZx_","mediumFont":"TDS_Typography-modules__mediumFont___XMrRj","large":"TDS_Typography-modules__large___24W-w TDS_Typography-modules__wordBreak___3OZx_","largeFont":"TDS_Typography-modules__largeFont___3k7bm TDS_Typography-modules__wordBreak___3OZx_","boldFont":"TDS_Typography-modules__boldFont___2YS3O TDS_Typography-modules__wordBreak___3OZx_","color":"TDS_Typography-modules__color___2CNH8","invertedColor":"TDS_Typography-modules__invertedColor___2tTa_","inheritColor":"TDS_Typography-modules__inheritColor___SREX0","blockText":"TDS_Typography-modules__blockText___2Gy51"};
+var styles = {"wordBreak":"TDS_Typography-modules__wordBreak___3OZx_","baseSupSubScripts":"TDS_Typography-modules__baseSupSubScripts___WeebJ","sup":"TDS_Typography-modules__sup___3IauS TDS_Typography-modules__baseSupSubScripts___WeebJ","default":"TDS_Typography-modules__default___KlcpP","base":"TDS_Typography-modules__base___2nkPE TDS_Typography-modules__wordBreak___3OZx_","baseFont":"TDS_Typography-modules__baseFont___2Cfk4","small":"TDS_Typography-modules__small___mt5lS TDS_Typography-modules__wordBreak___3OZx_","smallFont":"TDS_Typography-modules__smallFont___3S6nz","medium":"TDS_Typography-modules__medium___1rxfE TDS_Typography-modules__wordBreak___3OZx_","mediumFont":"TDS_Typography-modules__mediumFont___XMrRj","large":"TDS_Typography-modules__large___24W-w TDS_Typography-modules__wordBreak___3OZx_","largeFont":"TDS_Typography-modules__largeFont___3k7bm TDS_Typography-modules__wordBreak___3OZx_","boldFont":"TDS_Typography-modules__boldFont___2YS3O TDS_Typography-modules__wordBreak___3OZx_","color":"TDS_Typography-modules__color___2CNH8","invertedColor":"TDS_Typography-modules__invertedColor___2tTa_","inheritColor":"TDS_Typography-modules__inheritColor___SREX0","blockText":"TDS_Typography-modules__blockText___2Gy51"};
 
@@ -94,4 +94,13 @@ var safeRest = (function (_ref) {
 
+/* eslint-disable import/prefer-default-export */
+var deprecate = function deprecate(componentName, message) {
+  if (process.env.NODE_ENV === 'production') {
+    return;
+  }
+
+  console.warn("[TDS] [Deprecate] ".concat(componentName, ": ").concat(message)); // eslint-disable-line no-console
+};
+
 /**
- * Superscript text an as HTML `<sup>` element.
+ * @deprecated Superscript text an as HTML `<sup>` element.
  *
@@ -105,2 +114,3 @@ * _This component can only be accessed as a name-spaced component: `Text.Sup`._
 
+  deprecate('@tds/core-text', 'The Text.Sup component is deprecated. Please use a standard HTML sup element instead.');
   return React.createElement("sup", _extends_1({}, safeRest(rest), {
@@ -134,3 +144,3 @@ className: styles.sup
   var textColor = invert ? styles.invertedColor : styles.color;
-  var classes = joinClassNames(styles[size], bold ? styles.boldFont : styles["".concat(size, "Font")], context.inheritColor ? styles.inheritColor : textColor, block ? styles.blockText : null);
+  var classes = joinClassNames(styles.default, styles[size], bold ? styles.boldFont : styles["".concat(size, "Font")], context.inheritColor ? styles.inheritColor : textColor, block ? styles.blockText : null);
   return React.createElement("span", _extends_1({}, safeRest(rest), {
@@ -137,0 +147,0 @@ className: classes

dist/index.es.js

@@ -68,3 +68,3 @@ import React from 'react';
 
-var styles = {"wordBreak":"TDS_Typography-modules__wordBreak___3OZx_","baseSupSubScripts":"TDS_Typography-modules__baseSupSubScripts___WeebJ","sup":"TDS_Typography-modules__sup___3IauS TDS_Typography-modules__baseSupSubScripts___WeebJ","base":"TDS_Typography-modules__base___2nkPE TDS_Typography-modules__wordBreak___3OZx_","baseFont":"TDS_Typography-modules__baseFont___2Cfk4","small":"TDS_Typography-modules__small___mt5lS TDS_Typography-modules__wordBreak___3OZx_","smallFont":"TDS_Typography-modules__smallFont___3S6nz","medium":"TDS_Typography-modules__medium___1rxfE TDS_Typography-modules__wordBreak___3OZx_","mediumFont":"TDS_Typography-modules__mediumFont___XMrRj","large":"TDS_Typography-modules__large___24W-w TDS_Typography-modules__wordBreak___3OZx_","largeFont":"TDS_Typography-modules__largeFont___3k7bm TDS_Typography-modules__wordBreak___3OZx_","boldFont":"TDS_Typography-modules__boldFont___2YS3O TDS_Typography-modules__wordBreak___3OZx_","color":"TDS_Typography-modules__color___2CNH8","invertedColor":"TDS_Typography-modules__invertedColor___2tTa_","inheritColor":"TDS_Typography-modules__inheritColor___SREX0","blockText":"TDS_Typography-modules__blockText___2Gy51"};
+var styles = {"wordBreak":"TDS_Typography-modules__wordBreak___3OZx_","baseSupSubScripts":"TDS_Typography-modules__baseSupSubScripts___WeebJ","sup":"TDS_Typography-modules__sup___3IauS TDS_Typography-modules__baseSupSubScripts___WeebJ","default":"TDS_Typography-modules__default___KlcpP","base":"TDS_Typography-modules__base___2nkPE TDS_Typography-modules__wordBreak___3OZx_","baseFont":"TDS_Typography-modules__baseFont___2Cfk4","small":"TDS_Typography-modules__small___mt5lS TDS_Typography-modules__wordBreak___3OZx_","smallFont":"TDS_Typography-modules__smallFont___3S6nz","medium":"TDS_Typography-modules__medium___1rxfE TDS_Typography-modules__wordBreak___3OZx_","mediumFont":"TDS_Typography-modules__mediumFont___XMrRj","large":"TDS_Typography-modules__large___24W-w TDS_Typography-modules__wordBreak___3OZx_","largeFont":"TDS_Typography-modules__largeFont___3k7bm TDS_Typography-modules__wordBreak___3OZx_","boldFont":"TDS_Typography-modules__boldFont___2YS3O TDS_Typography-modules__wordBreak___3OZx_","color":"TDS_Typography-modules__color___2CNH8","invertedColor":"TDS_Typography-modules__invertedColor___2tTa_","inheritColor":"TDS_Typography-modules__inheritColor___SREX0","blockText":"TDS_Typography-modules__blockText___2Gy51"};
 
@@ -90,4 +90,13 @@ var safeRest = (function (_ref) {
 
+/* eslint-disable import/prefer-default-export */
+var deprecate = function deprecate(componentName, message) {
+  if (process.env.NODE_ENV === 'production') {
+    return;
+  }
+
+  console.warn("[TDS] [Deprecate] ".concat(componentName, ": ").concat(message)); // eslint-disable-line no-console
+};
+
 /**
- * Superscript text an as HTML `<sup>` element.
+ * @deprecated Superscript text an as HTML `<sup>` element.
  *
@@ -101,2 +110,3 @@ * _This component can only be accessed as a name-spaced component: `Text.Sup`._
 
+  deprecate('@tds/core-text', 'The Text.Sup component is deprecated. Please use a standard HTML sup element instead.');
   return React.createElement("sup", _extends_1({}, safeRest(rest), {
@@ -130,3 +140,3 @@ className: styles.sup
   var textColor = invert ? styles.invertedColor : styles.color;
-  var classes = joinClassNames(styles[size], bold ? styles.boldFont : styles["".concat(size, "Font")], context.inheritColor ? styles.inheritColor : textColor, block ? styles.blockText : null);
+  var classes = joinClassNames(styles.default, styles[size], bold ? styles.boldFont : styles["".concat(size, "Font")], context.inheritColor ? styles.inheritColor : textColor, block ? styles.blockText : null);
   return React.createElement("span", _extends_1({}, safeRest(rest), {
@@ -133,0 +143,0 @@ className: classes

package.json

 {
   "name": "@tds/core-text",
-  "version": "1.0.11",
+  "version": "1.1.0",
   "description": "Inline text",
@@ -28,3 +28,3 @@ "main": "index.cjs.js",
   "dependencies": {
-    "@tds/shared-typography": "^1.2.3",
+    "@tds/shared-typography": "^1.3.0",
     "prop-types": "^15.5.10"
@@ -35,3 +35,3 @@ },
   },
-  "gitHead": "24679ca1369e64d054bf825ab56b54cbb38180b4"
+  "gitHead": "1ac2f2499df5787982a6c0fd4196ca80d95dacfc"
 }

Text.jsx

@@ -20,2 +20,3 @@ import React from 'react'
   const classes = joinClassNames(
+    styles.default,
     styles[size],
@@ -22,0 +23,0 @@ bold ? styles.boldFont : styles[`${size}Font`],

Text.md

@@ -20,3 +20,3 @@ ### Minimal usage
     Get Optik TV
-    <Text.Sup>®</Text.Sup> and Internet for $85 per month for 12 months.
+    <sup>®</sup> and Internet for $85 per month for 12 months.
   </Text>
@@ -27,1 +27,14 @@ <br />
 ```
+
+### Using superscript copy within Text
+
+The `<Text.Sup>` component is deprecated. Use a standard HTML `<sup>` element instead.
+
+```jsx
+<Paragraph>
+  <Text>
+    Enjoy buffer-free streaming any time of day
+    <sup>2</sup>.
+  </Text>
+</Paragraph>
+```

TextSup/TextSup.jsx

@@ -6,14 +6,21 @@ import React from 'react'
 
+import { deprecate } from '../../../shared/utils/warn'
 import safeRest from '../../../shared/utils/safeRest'
 
 /**
- * Superscript text an as HTML `<sup>` element.
+ * @deprecated Superscript text an as HTML `<sup>` element.
  *
  * _This component can only be accessed as a name-spaced component: `Text.Sup`._
  */
-const TextSup = ({ children, ...rest }) => (
-  <sup {...safeRest(rest)} className={styles.sup}>
-    {children}
-  </sup>
-)
+const TextSup = ({ children, ...rest }) => {
+  deprecate(
+    '@tds/core-text',
+    'The Text.Sup component is deprecated. Please use a standard HTML sup element instead.'
+  )
+  return (
+    <sup {...safeRest(rest)} className={styles.sup}>
+      {children}
+    </sup>
+  )
+}
 
@@ -20,0 +27,0 @@ TextSup.propTypes = {

TextSup/TextSup.md

@@ -1,2 +0,2 @@
-Only use `Text.Sup` as a child of `Paragraph` or `Text`. Use [`Heading.Sup`](#headingsup) for superscript within headings.
+**Deprecated, please use a `<sup>` element documented in [Text](#text) instead.**
 
@@ -3,0 +3,0 @@ ```jsx

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

30422

increased by35.69%

Number of package files

19

increased by5.56%

Lines of code

516

increased by6.17%

Worsened metrics

Number of low supply chain risk alerts

2

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• Updated@tds/shared-typography@^1.3.0