@godxjp/ui 23.3.0 → 23.4.0

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

@@ -1,10 +1,14 @@
 import * as React from "react";
-export type { TextProp, TextProp as TextProps, HeadingProp, HeadingProp as HeadingProps, } from "../../props/components/general.prop.js";
+import type { TextProp, TypographyBlockProp } from "../../props/components/general.prop.js";
+import type { TypographyEllipsisConfigProp } from "../../props/vocabulary/index.js";
+export type { TextProp, TextProp as TextProps, HeadingProp, HeadingProp as HeadingProps, TypographyProp, TypographyProp as TypographyProps, TypographyBlockProp, TypographyTitleProp, TypographyTitleProp as TitleProps, ParagraphProp, ParagraphProp as ParagraphProps, LinkProp, LinkProp as LinkProps, } from "../../props/components/general.prop.js";
 /**
- * Text — the typographic primitive. Use it INSTEAD of a hand-rolled `<span className="text-[13px]
- * font-medium text-muted-foreground">`.
+ * Text — the typographic primitive, and antd's `Typography.Text`.
+ *
+ * Use it INSTEAD of a hand-rolled `<span className="text-[13px] font-medium text-muted-foreground">`.
+ * Size is a step of the type scale (never a px); tone and weight are tokens.
  */
-export declare const Text: React.ForwardRefExoticComponent<Omit<React.HTMLAttributes<HTMLElement>, "color"> & {
+export declare const Text: React.ForwardRefExoticComponent<Omit<React.HTMLAttributes<HTMLElement>, "color"> & Omit<TypographyBlockProp, "ellipsis"> & {
     as?: "span" | "p" | "div" | "a" | "label" | "strong" | "em" | "small" | "code" | "kbd" | "dt" | "dd" | "caption" | "abbr";
     asChild?: import("../../props/index.js").AsChildProp;
     link?: boolean;
@@ -14,6 +18,7 @@ export declare const Text: React.ForwardRefExoticComponent<Omit<React.HTMLAttrib
     align?: import("../../props/index.js").TextAlignProp;
     truncate?: boolean;
     clamp?: number;
+    ellipsis?: boolean | Omit<TypographyEllipsisConfigProp, "rows" | "expandable" | "onExpand">;
     whitespace?: import("../../props/index.js").TextWhitespaceProp;
     tabular?: boolean;
     decoration?: "none" | "underline" | "line-through";
@@ -25,9 +30,39 @@ export declare const Text: React.ForwardRefExoticComponent<Omit<React.HTMLAttrib
     rel?: string;
     download?: React.AnchorHTMLAttributes<HTMLAnchorElement>["download"];
 } & React.RefAttributes<HTMLElement>>;
+/**
+ * Paragraph — antd `Typography.Paragraph`.
+ *
+ * Renders a `<div>`, matching antd, because the editing textarea and the action cluster are block
+ * content that a `<p>` may not legally contain — a `<p>` would be split by the parser and the
+ * actions would end up OUTSIDE the paragraph. Pass `as="p"` when the content is phrasing-only.
+ *
+ * The one difference from `Text` is antd's: `ellipsis` here keeps `rows`, `expandable` and
+ * `onExpand`.
+ */
+export declare const Paragraph: React.ForwardRefExoticComponent<Omit<TextProp, "as" | "ellipsis"> & {
+    as?: "div" | "p" | "span";
+    ellipsis?: boolean | TypographyEllipsisConfigProp;
+} & React.RefAttributes<HTMLElement>>;
+/**
+ * Link — antd `Typography.Link`.
+ *
+ * `Text link` is the same affordance and is unchanged; `Link` is antd's anchor-by-default flavour
+ * of it. It adds antd's `rel` guard: a `target="_blank"` with no explicit `rel` gets
+ * `noopener noreferrer`, because the opened document otherwise keeps a live handle on
+ * `window.opener`. antd restricts `ellipsis` to a boolean on `Link`, and that restriction is ported
+ * by the type — `allowRows` stays off.
+ */
+export declare const Link: React.ForwardRefExoticComponent<Omit<TextProp, "as" | "ellipsis"> & {
+    as?: "a" | "span";
+    ellipsis?: boolean;
+} & React.RefAttributes<HTMLElement>>;
 /**
  * Heading — h1..h4 sized from the `--heading-h*` tokens. `level` sets both the size token and the
  * semantic element; override the rendered element with `as` (e.g. a visual h2 that is a real <h1>).
+ *
+ * UNCHANGED by the antd port. antd's heading is `Title`, which is the sibling below; `Heading` is
+ * this library's own and keeps its four levels, its props and its markup exactly as they shipped.
  */
 export declare const Heading: React.ForwardRefExoticComponent<Omit<React.HTMLAttributes<HTMLHeadingElement>, "color"> & {
     level?: import("../../props/index.js").HeadingLevelProp;
@@ -37,3 +72,43 @@ export declare const Heading: React.ForwardRefExoticComponent<Omit<React.HTMLAtt
     truncate?: boolean;
     weight?: import("../../props/index.js").FontWeightProp;
 } & React.RefAttributes<HTMLHeadingElement>>;
+/**
+ * Title — antd `Typography.Title`.
+ *
+ * A SIBLING of `Heading`, not a replacement: five levels instead of four, plus the antd block
+ * behaviours (`copyable`, `editable`, `ellipsis`, the decorations). antd omits `strong` here
+ * because a heading already renders at the strong weight, and that omission is ported.
+ */
+export declare const Title: React.ForwardRefExoticComponent<Omit<React.HTMLAttributes<HTMLHeadingElement>, "color"> & Omit<TypographyBlockProp, "strong"> & {
+    level?: import("../../props/index.js").TitleLevelProp;
+    as?: "h1" | "h2" | "h3" | "h4" | "h5" | "div";
+    tone?: import("../../props/index.js").TextToneProp;
+    align?: import("../../props/index.js").TextAlignProp;
+    truncate?: boolean;
+    weight?: import("../../props/index.js").FontWeightProp;
+    ellipsis?: boolean | TypographyEllipsisConfigProp;
+} & React.RefAttributes<HTMLElement>>;
+/**
+ * Typography — antd's plain wrapper for a run of prose.
+ *
+ * It renders an `<article>` and carries no emphasis of its own. It exists so `Title`, `Paragraph`,
+ * `Text` and `Link` have a container with the reading measure and the block rhythm on it, and so
+ * the compound spelling every antd codebase is written in — `<Typography.Text>` — works here
+ * unchanged.
+ */
+declare const TypographyRoot: React.ForwardRefExoticComponent<Omit<React.HTMLAttributes<HTMLElement>, "color"> & {
+    as?: string;
+    component?: string;
+} & React.RefAttributes<HTMLElement>>;
+type TypographyCompound = typeof TypographyRoot & {
+    Text: typeof Text;
+    Title: typeof Title;
+    Paragraph: typeof Paragraph;
+    Link: typeof Link;
+};
+/**
+ * The compound export. `Typography.Text` and the bare `Text` are the SAME component — there is no
+ * second, poorer Text — so a paste from an antd codebase and a call written in this library's own
+ * style compile to the same thing.
+ */
+export declare const Typography: TypographyCompound;