@hkdigital/lib-sveltekit 0.1.6 → 0.1.8

package/dist/util/design-system/tailwind.d.ts

@@ -1,12 +1,12 @@
 /**
  * Generates text-based spacing units with with different scaling
- * units (ut, ct, ht)
+ * units (ut, bt, ht)
  *
  * @param {number[]} values
  *   Array of pixel values to generate text-based spacing units for
  *
  * @returns {{[key: string]: string}}
- *   Generated text-based spacing units with ut, ct, and ht suffixes
+ *   Generated text-based spacing units with ut, bt, and ht suffixes
  *
  * @throws {Error} If values is not an array or contains non-numeric values
  *
@@ -16,8 +16,8 @@
  * // {
  * //   '1ut': 'calc(1px * var(--scale-text-ui))',
  * //   '2ut': 'calc(2px * var(--scale-text-ui))',
- * //   '1ct': 'calc(1px * var(--scale-text-content))',
- * //   '2ct': 'calc(2px * var(--scale-text-content))',
+ * //   '1bt': 'calc(1px * var(--scale-text-base))',
+ * //   '2bt': 'calc(2px * var(--scale-text-base))',
  * //   '1ht': 'calc(1px * var(--scale-text-heading))',
  * //   '2ht': 'calc(2px * var(--scale-text-heading))'
  * // }
@@ -27,15 +27,15 @@ export function generateTextBasedSpacing(values: number[]): {
 };
 /**
  * Generates viewport-based spacing units with different scaling
- * units (p, vp, wp, hp)
+ * units (up, wp, hp)
  *
  * @param {number[]} values
  *   Array of pixel values to generate viewport-based spacing units for
  *
  * @returns {Object.<string, string>}
  *   Generated viewport-based spacing units:
- *   - p:  UI points (clamped scaling)
- *   - vp: Viewport points (min of width/height)
+ *   - up: UI points (clamped scaling)
+ *   - p:  UI points (deprecated, will be removed in future versions)
  *   - wp: Width points
  *   - hp: Height points
  *
@@ -45,8 +45,8 @@ export function generateTextBasedSpacing(values: number[]): {
  * generateViewportBasedSpacing([1, 2, 4])
  * // Returns:
  * // {
- * //   '1p': 'calc(1px * var(--scale-ui))',
- * //   '1vp': 'calc(1px * var(--scale-viewport))',
+ * //   '1up': 'calc(1px * var(--scale-ui))',
+ * //   '1p': 'calc(1px * var(--scale-ui))',  // deprecated
  * //   '1wp': 'calc(1px * var(--scale-w))',
  * //   '1hp': 'calc(1px * var(--scale-h))'
  * // }
@@ -56,13 +56,13 @@ export function generateViewportBasedSpacing(values: number[]): {
 };
 /**
  * Generates semantic text style definitions for a specific text category
- * (content, UI, or heading). Each style includes a scaled font size and
+ * (base, UI, or heading). Each style includes a scaled font size and
  * line height.
  *
  * @param {{[key: string]: {size: number, lineHeight?: number}}} sizes
  *   Set of text sizes to generate styles for
  *
- * @param {'content' | 'ui' | 'heading'} category
+ * @param {'base' | 'ui' | 'heading'} category
  *   Text category to generate styles for
  *
  * @returns {{[key: string]: [string, {lineHeight: number}]}}
@@ -71,21 +71,21 @@ export function generateViewportBasedSpacing(values: number[]): {
  * @throws {Error} If a size has an invalid size or lineHeight
  *
  * @example
- * const TEXT_CONTENT_SIZES = {
+ * const TEXT_BASE_SIZES = {
  *   sm: { size: 16, lineHeight: 1.5 },
  *   base: { size: 20, lineHeight: 1.5 },
  *   lg: { size: 24, lineHeight: 1.4 }
  * };
  *
- * generateTextStyles(TEXT_CONTENT_SIZES, 'content');
+ * generateTextStyles(TEXT_BASE_SIZES, 'base');
  * // Returns:
  * // {
- * //   'content-sm':
- * //     ['calc(16px * var(--scale-text-content))', { lineHeight: 1.5 }],
- * //   'content-base':
- * //     ['calc(20px * var(--scale-text-content))', { lineHeight: 1.5 }],
- * //   'content-lg':
- * //     ['calc(24px * var(--scale-text-content))', { lineHeight: 1.4 }]
+ * //   'base-sm':
+ * //     ['calc(16px * var(--scale-text-base))', { lineHeight: 1.5 }],
+ * //   'base-base':
+ * //     ['calc(20px * var(--scale-text-base))', { lineHeight: 1.5 }],
+ * //   'base-lg':
+ * //     ['calc(24px * var(--scale-text-base))', { lineHeight: 1.4 }]
  * // }
  */
 export function generateTextStyles(sizes: {
@@ -93,7 +93,7 @@ export function generateTextStyles(sizes: {
         size: number;
         lineHeight?: number;
     };
-}, category: "content" | "ui" | "heading"): {
+}, category: "base" | "ui" | "heading"): {
     [key: string]: [string, {
         lineHeight: number;
     }];