@spark-web/text 5.2.0 → 5.2.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @spark-web/text
 
+## 5.2.1
+
+### Patch Changes
+
+- [#685](https://github.com/brighte-labs/spark-web/pull/685)
+  [`ffbfa06`](https://github.com/brighte-labs/spark-web/commit/ffbfa066a4b2f72a838e68b49dd2c63ac44621a1)
+  Thanks [@michtntbrighte](https://github.com/michtntbrighte)! - : add truncate
+  the text with an ellipsis by number of lines
+
 ## 5.2.0
 
 ### Minor Changes

package/dist/declarations/src/context.d.ts

@@ -2,10 +2,10 @@
 export declare const TextContext: import("react").Context<{
     size: import("@spark-web/theme/src/themes/_types/typography").TypographySizing;
     tone: string | number;
-    weight: "bold" | "medium" | "light" | "thin" | "black" | "extralight" | "regular" | "semibold" | "extrabold" | undefined;
+    weight: "medium" | "light" | "thin" | "extralight" | "regular" | "semibold" | "bold" | "extrabold" | "black" | undefined;
 } | undefined>;
 export declare function useTextContext(): {
     size: import("@spark-web/theme/src/themes/_types/typography").TypographySizing;
     tone: string | number;
-    weight: "bold" | "medium" | "light" | "thin" | "black" | "extralight" | "regular" | "semibold" | "extrabold" | undefined;
+    weight: "medium" | "light" | "thin" | "extralight" | "regular" | "semibold" | "bold" | "extrabold" | "black" | undefined;
 } | undefined;

package/dist/declarations/src/default-text-props.d.ts

@@ -11,6 +11,6 @@ export declare function DefaultTextPropsProvider({ children, size, tone, weight,
 export declare const useDefaultTextProps: ({ size: sizeProp, tone: toneProp, weight: weightProp, }: DefaultTextProps) => {
     size: import("@spark-web/theme/src/themes/_types/typography").TypographySizing;
     tone: string | number;
-    weight: "bold" | "medium" | "light" | "thin" | "black" | "extralight" | "regular" | "semibold" | "extrabold" | undefined;
+    weight: "medium" | "light" | "thin" | "extralight" | "regular" | "semibold" | "bold" | "extrabold" | "black" | undefined;
 };
 export {};

package/dist/declarations/src/index.d.ts

@@ -3,6 +3,7 @@ export { DefaultTextPropsProvider, useDefaultTextProps, } from "./default-text-p
 export { Strong } from "./strong.js";
 export { Text } from "./text.js";
 export { useForegroundTone } from "./use-foreground-tone.js";
+export { useNumberOfLines } from "./use-number-of-lines.js";
 export { useOverflowStrategy } from "./use-overflow-strategy.js";
 export { createTextStyles, useText } from "./use-text.js";
 export type { StrongProps } from "./strong.js";

package/dist/declarations/src/text.d.ts

@@ -31,9 +31,12 @@ export declare type TextProps = Partial<UseTextProps> & {
     tabularNumbers?: boolean;
     /** Transform the text casing. */
     transform?: CSSProperties['textTransform'];
+    /** Truncate the text with an ellipsis after computing the text layout, including line wrapping,
+     * such that the total number of lines does not exceed this number. */
+    numberOfLines?: number;
 } & (InlineProps | BlockProps);
 export declare const Text: <Comp extends import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> = "div">(props: {
     as?: Comp | undefined;
-    ref?: import("react").Ref<Comp extends "symbol" | "svg" | "animate" | "animateMotion" | "animateTransform" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "set" | "stop" | "switch" | "text" | "textPath" | "tspan" | "use" | "view" | keyof HTMLElementTagNameMap ? (HTMLElementTagNameMap & Pick<SVGElementTagNameMap, "symbol" | "svg" | "animate" | "animateMotion" | "animateTransform" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "set" | "stop" | "switch" | "text" | "textPath" | "tspan" | "use" | "view">)[Comp] : Comp extends new (...args: any) => any ? InstanceType<Comp> : undefined> | undefined;
+    ref?: import("react").Ref<Comp extends "symbol" | "clipPath" | "filter" | "mask" | "marker" | "svg" | "animate" | "animateMotion" | "animateTransform" | "circle" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "set" | "stop" | "switch" | "text" | "textPath" | "tspan" | "use" | "view" | keyof HTMLElementTagNameMap ? (HTMLElementTagNameMap & Pick<SVGElementTagNameMap, "symbol" | "clipPath" | "filter" | "mask" | "marker" | "svg" | "animate" | "animateMotion" | "animateTransform" | "circle" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "set" | "stop" | "switch" | "text" | "textPath" | "tspan" | "use" | "view">)[Comp] : Comp extends new (...args: any) => any ? InstanceType<Comp> : undefined> | undefined;
 } & Omit<import("react").PropsWithoutRef<import("react").ComponentProps<Comp>>, "as"> & TextProps) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
 export {};

package/dist/declarations/src/use-number-of-lines.d.ts

@@ -0,0 +1,2 @@
+import type { CSSProperties } from 'react';
+export declare const useNumberOfLines: (numberOfLines?: number) => CSSProperties;

package/dist/spark-web-text.cjs.dev.js

@@ -66,6 +66,23 @@ var Strong = function Strong(_ref) {
   });
 };
 
+var useNumberOfLines = function useNumberOfLines(numberOfLines) {
+  if (!numberOfLines) {
+    return {};
+  }
+  return {
+    overflow: 'hidden',
+    display: '-webkit-box',
+    WebkitLineClamp: numberOfLines,
+    lineClamp: numberOfLines,
+    WebkitBoxOrient: 'vertical',
+    textOverflow: 'ellipsis',
+    overflowWrap: 'break-word',
+    wordBreak: 'break-word',
+    wordWrap: 'break-word'
+  };
+};
+
 var strategyMap = {
   truncate: {
     display: 'block',
@@ -171,7 +188,7 @@ function createTextStyles(_ref2) {
   }, leadingTrim);
 }
 
-var _excluded = ["as", "children", "data", "id", "align", "baseline", "css", "inline", "overflowStrategy", "size", "tabularNumbers", "tone", "transform", "weight"];
+var _excluded = ["as", "children", "data", "id", "align", "baseline", "css", "inline", "overflowStrategy", "size", "tabularNumbers", "tone", "transform", "weight", "numberOfLines"];
 var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
   var as = _ref.as,
     children = _ref.children,
@@ -187,6 +204,7 @@ var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
     toneProp = _ref.tone,
     transform = _ref.transform,
     weightProp = _ref.weight,
+    numberOfLines = _ref.numberOfLines,
     consumerProps = _objectWithoutProperties(_ref, _excluded);
   var overflowStyles = useOverflowStrategy(overflowStrategy);
   var textContext = useTextContext();
@@ -205,6 +223,7 @@ var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
     tone: tone,
     weight: weight
   });
+  var numberOfLinesStyle = useNumberOfLines(numberOfLines);
   var styles = [textStyles, {
     display: inline ? 'inline' : 'block',
     fontVariantNumeric: tabularNumbers ? 'tabular-nums' : undefined,
@@ -225,12 +244,21 @@ var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
   }
 
   // prepare block variant
-  var content = overflowStrategy ?
-  // eslint-disable-next-line react/no-unknown-property
-  jsxRuntime.jsx("span", {
-    css: react$1.css(overflowStyles),
-    children: children
-  }) : children;
+  var content = function content() {
+    if (overflowStrategy) {
+      return jsxRuntime.jsx("span", {
+        css: react$1.css(overflowStyles),
+        children: children
+      });
+    }
+    if (numberOfLines) {
+      return jsxRuntime.jsx("span", {
+        style: numberOfLinesStyle,
+        children: children
+      });
+    }
+    return children;
+  };
   var textContextValue = react.useMemo(function () {
     return {
       size: size,
@@ -246,7 +274,7 @@ var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
       ref: forwardedRef,
       id: id,
       css: react$1.css(styles, cssProps),
-      children: content
+      children: content()
     }))
   });
 });
@@ -257,6 +285,7 @@ exports.Text = Text;
 exports.createTextStyles = createTextStyles;
 exports.useDefaultTextProps = useDefaultTextProps;
 exports.useForegroundTone = useForegroundTone;
+exports.useNumberOfLines = useNumberOfLines;
 exports.useOverflowStrategy = useOverflowStrategy;
 exports.useText = useText;
 exports.useTextContext = useTextContext;

package/dist/spark-web-text.cjs.prod.js

@@ -66,6 +66,23 @@ var Strong = function Strong(_ref) {
   });
 };
 
+var useNumberOfLines = function useNumberOfLines(numberOfLines) {
+  if (!numberOfLines) {
+    return {};
+  }
+  return {
+    overflow: 'hidden',
+    display: '-webkit-box',
+    WebkitLineClamp: numberOfLines,
+    lineClamp: numberOfLines,
+    WebkitBoxOrient: 'vertical',
+    textOverflow: 'ellipsis',
+    overflowWrap: 'break-word',
+    wordBreak: 'break-word',
+    wordWrap: 'break-word'
+  };
+};
+
 var strategyMap = {
   truncate: {
     display: 'block',
@@ -171,7 +188,7 @@ function createTextStyles(_ref2) {
   }, leadingTrim);
 }
 
-var _excluded = ["as", "children", "data", "id", "align", "baseline", "css", "inline", "overflowStrategy", "size", "tabularNumbers", "tone", "transform", "weight"];
+var _excluded = ["as", "children", "data", "id", "align", "baseline", "css", "inline", "overflowStrategy", "size", "tabularNumbers", "tone", "transform", "weight", "numberOfLines"];
 var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
   var as = _ref.as,
     children = _ref.children,
@@ -187,6 +204,7 @@ var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
     toneProp = _ref.tone,
     transform = _ref.transform,
     weightProp = _ref.weight,
+    numberOfLines = _ref.numberOfLines,
     consumerProps = _objectWithoutProperties(_ref, _excluded);
   var overflowStyles = useOverflowStrategy(overflowStrategy);
   var textContext = useTextContext();
@@ -205,6 +223,7 @@ var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
     tone: tone,
     weight: weight
   });
+  var numberOfLinesStyle = useNumberOfLines(numberOfLines);
   var styles = [textStyles, {
     display: inline ? 'inline' : 'block',
     fontVariantNumeric: tabularNumbers ? 'tabular-nums' : undefined,
@@ -225,12 +244,21 @@ var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
   }
 
   // prepare block variant
-  var content = overflowStrategy ?
-  // eslint-disable-next-line react/no-unknown-property
-  jsxRuntime.jsx("span", {
-    css: react$1.css(overflowStyles),
-    children: children
-  }) : children;
+  var content = function content() {
+    if (overflowStrategy) {
+      return jsxRuntime.jsx("span", {
+        css: react$1.css(overflowStyles),
+        children: children
+      });
+    }
+    if (numberOfLines) {
+      return jsxRuntime.jsx("span", {
+        style: numberOfLinesStyle,
+        children: children
+      });
+    }
+    return children;
+  };
   var textContextValue = react.useMemo(function () {
     return {
       size: size,
@@ -246,7 +274,7 @@ var Text = ts.forwardRefWithAs(function (_ref, forwardedRef) {
       ref: forwardedRef,
       id: id,
       css: react$1.css(styles, cssProps),
-      children: content
+      children: content()
     }))
   });
 });
@@ -257,6 +285,7 @@ exports.Text = Text;
 exports.createTextStyles = createTextStyles;
 exports.useDefaultTextProps = useDefaultTextProps;
 exports.useForegroundTone = useForegroundTone;
+exports.useNumberOfLines = useNumberOfLines;
 exports.useOverflowStrategy = useOverflowStrategy;
 exports.useText = useText;
 exports.useTextContext = useTextContext;

package/dist/spark-web-text.esm.js

@@ -62,6 +62,23 @@ var Strong = function Strong(_ref) {
   });
 };
 
+var useNumberOfLines = function useNumberOfLines(numberOfLines) {
+  if (!numberOfLines) {
+    return {};
+  }
+  return {
+    overflow: 'hidden',
+    display: '-webkit-box',
+    WebkitLineClamp: numberOfLines,
+    lineClamp: numberOfLines,
+    WebkitBoxOrient: 'vertical',
+    textOverflow: 'ellipsis',
+    overflowWrap: 'break-word',
+    wordBreak: 'break-word',
+    wordWrap: 'break-word'
+  };
+};
+
 var strategyMap = {
   truncate: {
     display: 'block',
@@ -167,7 +184,7 @@ function createTextStyles(_ref2) {
   }, leadingTrim);
 }
 
-var _excluded = ["as", "children", "data", "id", "align", "baseline", "css", "inline", "overflowStrategy", "size", "tabularNumbers", "tone", "transform", "weight"];
+var _excluded = ["as", "children", "data", "id", "align", "baseline", "css", "inline", "overflowStrategy", "size", "tabularNumbers", "tone", "transform", "weight", "numberOfLines"];
 var Text = forwardRefWithAs(function (_ref, forwardedRef) {
   var as = _ref.as,
     children = _ref.children,
@@ -183,6 +200,7 @@ var Text = forwardRefWithAs(function (_ref, forwardedRef) {
     toneProp = _ref.tone,
     transform = _ref.transform,
     weightProp = _ref.weight,
+    numberOfLines = _ref.numberOfLines,
     consumerProps = _objectWithoutProperties(_ref, _excluded);
   var overflowStyles = useOverflowStrategy(overflowStrategy);
   var textContext = useTextContext();
@@ -201,6 +219,7 @@ var Text = forwardRefWithAs(function (_ref, forwardedRef) {
     tone: tone,
     weight: weight
   });
+  var numberOfLinesStyle = useNumberOfLines(numberOfLines);
   var styles = [textStyles, {
     display: inline ? 'inline' : 'block',
     fontVariantNumeric: tabularNumbers ? 'tabular-nums' : undefined,
@@ -221,12 +240,21 @@ var Text = forwardRefWithAs(function (_ref, forwardedRef) {
   }
 
   // prepare block variant
-  var content = overflowStrategy ?
-  // eslint-disable-next-line react/no-unknown-property
-  jsx("span", {
-    css: css(overflowStyles),
-    children: children
-  }) : children;
+  var content = function content() {
+    if (overflowStrategy) {
+      return jsx("span", {
+        css: css(overflowStyles),
+        children: children
+      });
+    }
+    if (numberOfLines) {
+      return jsx("span", {
+        style: numberOfLinesStyle,
+        children: children
+      });
+    }
+    return children;
+  };
   var textContextValue = useMemo(function () {
     return {
       size: size,
@@ -242,9 +270,9 @@ var Text = forwardRefWithAs(function (_ref, forwardedRef) {
       ref: forwardedRef,
       id: id,
       css: css(styles, cssProps),
-      children: content
+      children: content()
     }))
   });
 });
 
-export { DefaultTextPropsProvider, Strong, Text, createTextStyles, useDefaultTextProps, useForegroundTone, useOverflowStrategy, useText, useTextContext };
+export { DefaultTextPropsProvider, Strong, Text, createTextStyles, useDefaultTextProps, useForegroundTone, useNumberOfLines, useOverflowStrategy, useText, useTextContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spark-web/text",
-  "version": "5.2.0",
+  "version": "5.2.1",
   "homepage": "https://github.com/brighte-labs/spark-web#readme",
   "repository": {
     "type": "git",