@npm-questionpro/wick-ui-lib 2.0.0-next.24 → 2.0.0-next.26

package/dist/components/typography/WuTypography.d.ts

@@ -1,20 +1,80 @@
 import React from 'react';
 import type { IWuIcons } from './iconTypes';
-export declare const WuText: React.FC<React.HTMLAttributes<HTMLParagraphElement> & {
+export interface IWuTextProps extends React.HTMLAttributes<HTMLParagraphElement> {
+    /** Body text scale. @default 'lg' */
     size?: 'sm' | 'md' | 'lg';
+    /** Underlying HTML element. @default 'div' */
     as?: 'p' | 'div' | 'span';
-}>;
-export declare const WuHeading: React.FC<React.HTMLAttributes<HTMLHeadingElement> & {
+}
+/**
+ * Body text for paragraphs and general content.
+ *
+ * @summary default text primitive — reach for it for any non-heading copy
+ */
+export declare const WuText: React.FC<IWuTextProps>;
+export interface IWuHeadingProps extends React.HTMLAttributes<HTMLHeadingElement> {
+    /** Heading scale; also picks the semantic tag (xl→h1 … sm→h4). @default 'xl' */
     size?: 'sm' | 'md' | 'lg' | 'xl';
-}>;
-export declare const WuSubtext: React.FC<React.HTMLAttributes<HTMLParagraphElement> & {
+}
+/**
+ * Section and page headings with matching semantic levels.
+ *
+ * @summary heading primitive — size drives both visual scale and h1–h4 tag
+ */
+export declare const WuHeading: React.FC<IWuHeadingProps>;
+export interface IWuSubtextProps extends React.HTMLAttributes<HTMLParagraphElement> {
+    /** Subtitle scale. @default 'lg' */
     size?: 'sm' | 'md' | 'lg';
+    /** Underlying HTML element. @default 'div' */
     as?: 'p' | 'div' | 'span';
-}>;
-export declare const WuDisplay: React.FC<React.HTMLAttributes<HTMLHeadingElement> & {
+}
+/**
+ * Secondary text for captions, labels, and metadata.
+ *
+ * @summary muted supporting text — use beneath or beside primary content
+ */
+export declare const WuSubtext: React.FC<IWuSubtextProps>;
+export interface IWuDisplayProps extends React.HTMLAttributes<HTMLHeadingElement> {
+    /** Display scale. @default 'lg' */
     size?: 'md' | 'lg';
+    /** Underlying HTML element. @default 'h1' */
     as?: 'h1' | 'h2' | 'h3' | 'h4' | 'div';
-}>;
-export declare const WuIcon: React.FC<React.BaseHTMLAttributes<HTMLBaseElement> & {
+}
+/**
+ * Oversized text for hero sections and page intros.
+ *
+ * @summary largest type ramp — sparing, attention-grabbing display copy
+ */
+export declare const WuDisplay: React.FC<IWuDisplayProps>;
+export interface IWuIconProps extends React.BaseHTMLAttributes<HTMLBaseElement> {
+    /** Icon-font identifier to render. */
     icon: IWuIcons;
-}>;
+}
+/**
+ * Renders an icon-font glyph as a decorative, accessible span.
+ *
+ * @summary icon-font primitive — size/color via text utilities
+ */
+export declare const WuIcon: React.FC<IWuIconProps>;
+/** Typography components WuNumber can render its value into via the `as` prop. */
+declare const numberTagMap: {
+    readonly WuText: React.FC<IWuTextProps>;
+    readonly WuHeading: React.FC<IWuHeadingProps>;
+    readonly WuSubtext: React.FC<IWuSubtextProps>;
+    readonly WuDisplay: React.FC<IWuDisplayProps>;
+};
+export interface IWuNumberProps extends React.HTMLAttributes<HTMLSpanElement> {
+    /** Intl.NumberFormat options — style, currency, notation, fraction digits, etc. */
+    format?: Intl.NumberFormatOptions;
+    /** BCP-47 locale tag. @default browser locale */
+    locale?: string;
+    /** Render the value inside a typography component instead of a bare span. @default 'span' */
+    as?: keyof typeof numberTagMap;
+}
+/**
+ * Formats a numeric value with `Intl.NumberFormat` and renders it in a styled span.
+ *
+ * @summary locale-aware number/currency/percent formatter — Intl options in, formatted text out
+ */
+export declare function WuNumber({ children, className, format, locale, as, ...rest }: IWuNumberProps): React.JSX.Element;
+export {};