@antscorp/ui 0.1.1 → 0.1.3

package/README.md

@@ -23,5 +23,5 @@ export function Example() {
 ```
 
 StyleX consumers select `antscorp-source` and extract their own CSS instead of importing
-`ui.css`. See the [repository README](https://bitbucket.org/git-vn/at.antsomi-ui/src/main/README.md)
+`ui.css`. See the [repository README](../../README.md)
 for source configuration, linked development and releases.

package/dist/atoms/AddButton.d.ts

@@ -9,7 +9,7 @@ export type AddButtonProps = {
     readonly size?: "sm" | "md" | undefined;
     /** `default` keeps the button's own corners; `pill` rounds them fully; the theme colours its outline. */
     readonly shape?: "default" | "pill" | undefined;
-    /** `sentence` (default) shows the label as given; `upper` in capitals, as fe-app's "+ AND". */
+    /** `sentence` (default) shows the label as given; `upper` in capitals, such as "+ AND". */
     readonly case?: "sentence" | "upper" | undefined;
     /** Dimmed and not pressable, e.g. when a limit is reached. */
     readonly isDisabled?: boolean | undefined;

package/dist/atoms/AddButton.doc.d.ts

@@ -0,0 +1,21 @@
+/** Usage guidance for AddButton. */
+export declare const doc: {
+    category: "Inputs";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: {
+            name: string;
+            required: true;
+            description: string;
+        }[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/AddGlyph.doc.d.ts

@@ -0,0 +1,16 @@
+/** Usage guidance for AddGlyph. */
+export declare const doc: {
+    category: "Data display";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/Chip.doc.d.ts

@@ -0,0 +1,29 @@
+/** Usage guidance for Chip. */
+export declare const doc: {
+    category: "Data display";
+    keywords: string[];
+    related: {
+        name: string;
+        when: string;
+    }[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: ({
+            name: string;
+            required: true;
+            description: string;
+        } | {
+            name: string;
+            required: false;
+            description: string;
+        })[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/ChipSkeletons.doc.d.ts

@@ -0,0 +1,21 @@
+/** Usage guidance for ChipSkeletons. */
+export declare const doc: {
+    category: "Feedback";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: {
+            name: string;
+            required: true;
+            description: string;
+        }[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/FieldHeading.doc.d.ts

@@ -0,0 +1,15 @@
+/** Usage guidance for FieldHeading. */
+export declare const doc: {
+    category: "Data display";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+    };
+};

package/dist/atoms/HoverSwap.doc.d.ts

@@ -0,0 +1,25 @@
+/** Usage guidance for HoverSwap. */
+export declare const doc: {
+    category: "Layout";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: ({
+            name: string;
+            required: false;
+            description: string;
+        } | {
+            name: string;
+            required: true;
+            description: string;
+        })[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/InfoTip.doc.d.ts

@@ -0,0 +1,25 @@
+/** Usage guidance for InfoTip. */
+export declare const doc: {
+    category: "Feedback";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: ({
+            name: string;
+            required: true;
+            description: string;
+        } | {
+            name: string;
+            required: false;
+            description: string;
+        })[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/InfoTip.js

@@ -17,6 +17,7 @@ function a(a) {
 	let m;
 	s[5] !== c || s[6] !== p ? (m = /* @__PURE__ */ t(i, {
 		as: "span",
+		tabIndex: 0,
 		color: "accent",
 		"aria-label": c,
 		xstyle: o.info,
@@ -25,6 +26,7 @@ function a(a) {
 	let h;
 	return s[8] !== c || s[9] !== m ? (h = /* @__PURE__ */ t(r, {
 		content: c,
+		focusTrigger: "always",
 		children: m
 	}), s[8] = c, s[9] = m, s[10] = h) : h = s[10], h;
 }

package/dist/atoms/JointLabel.doc.d.ts

@@ -0,0 +1,15 @@
+/** Usage guidance for JointLabel. */
+export declare const doc: {
+    category: "Data display";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+    };
+};

package/dist/atoms/LabeledDivider.d.ts

@@ -3,7 +3,7 @@ import type { ReactNode } from "react";
 export type LabeledDividerProps = {
     /** The short word on the rule, such as "or"; it also names the separator. */
     readonly label: string;
-    /** `sentence` (default) shows the word as given; `upper` in capitals, as fe-app's "OR". */
+    /** `sentence` (default) shows the word as given; `upper` in capitals, such as "OR". */
     readonly case?: "sentence" | "upper" | undefined;
 };
 /**

package/dist/atoms/LabeledDivider.doc.d.ts

@@ -0,0 +1,21 @@
+/** Usage guidance for LabeledDivider. */
+export declare const doc: {
+    category: "Layout";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: {
+            name: string;
+            required: true;
+            description: string;
+        }[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/LogoImage.doc.d.ts

@@ -0,0 +1,21 @@
+/** Usage guidance for LogoImage. */
+export declare const doc: {
+    category: "Data display";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: {
+            name: string;
+            required: false;
+            description: string;
+        }[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/PanelSearchInput.d.ts

@@ -14,7 +14,7 @@ export type PanelSearchInputProps = {
         /** The clear button's name, such as "Clear search"; it shows only an icon. */
         readonly clear: string;
     };
-    /** Where the magnifier sits: `start` (default) or `end`, after the clear button, as fe-app's search. */
+    /** Where the magnifier sits: `start` (default) or `end`, after the clear button. */
     readonly iconPosition?: "start" | "end" | undefined;
     /** The input element, to focus it (with `useFocusLater` in a pop-over, say). */
     readonly ref?: Ref<HTMLInputElement> | undefined;

package/dist/atoms/PanelSearchInput.doc.d.ts

@@ -0,0 +1,25 @@
+/** Usage guidance for PanelSearchInput. */
+export declare const doc: {
+    category: "Inputs";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: ({
+            name: string;
+            required: true;
+            description: string;
+        } | {
+            name: string;
+            required: false;
+            description: string;
+        })[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/PathMark.doc.d.ts

@@ -0,0 +1,16 @@
+/** Usage guidance for PathMark. */
+export declare const doc: {
+    category: "Layout";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/RemoveButton.doc.d.ts

@@ -0,0 +1,16 @@
+/** Usage guidance for RemoveButton. */
+export declare const doc: {
+    category: "Inputs";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/RowSkeletons.doc.d.ts

@@ -0,0 +1,25 @@
+/** Usage guidance for RowSkeletons. */
+export declare const doc: {
+    category: "Feedback";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: ({
+            name: string;
+            required: true;
+            description: string;
+        } | {
+            name: string;
+            required: false;
+            description: string;
+        })[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/TextAction.d.ts

@@ -5,7 +5,7 @@ export type TextActionProps = {
     readonly label: string;
     /** A glyph before the text, in the text's colour, such as an Astryx `Icon` of a bin for a removal. */
     readonly icon?: ReactNode;
-    /** `upper` (default) shows the label in capitals, as fe-app's "REMOVE ALL"; `sentence` as given, as fe-app's text buttons. */
+    /** `upper` (default) shows the label in capitals, such as "REMOVE ALL"; `sentence` as given. */
     readonly case?: "upper" | "sentence" | undefined;
     /**
      * Called when it is pressed. Leave it out when a wrapper handles the presses, such as an Astryx
@@ -18,8 +18,8 @@ export type TextActionProps = {
     readonly isDisabled?: boolean | undefined;
 };
 /**
- * An action drawn as text alone: bold capitals in the accent, no frame, as fe-app's "REMOVE ALL"
- * and "CREATE NEW … ▾", or in sentence case with a glyph before it, as fe-app's text buttons
+ * An action drawn as text alone: bold capitals in the accent, no frame, such as "REMOVE ALL"
+ * and "CREATE NEW … ▾", or in sentence case with a glyph before it
  * (a bin, then "Remove"). An Astryx `Link` without an `href`, so a `<button>` in a link's look, with
  * a down chevron after the text when it opens a menu; still a button without `onClick`, so it can
  * be a `Popover`'s trigger. It holds no state.

package/dist/atoms/TextAction.doc.d.ts

@@ -0,0 +1,25 @@
+/** Usage guidance for TextAction. */
+export declare const doc: {
+    category: "Inputs";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: ({
+            name: string;
+            required: true;
+            description: string;
+        } | {
+            name: string;
+            required: false;
+            description: string;
+        })[];
+    };
+    accessibility: string[];
+};

package/dist/atoms/TruncatedOption.d.ts

@@ -7,7 +7,7 @@ export type TruncatedOptionProps = {
 };
 /**
  * A Selector option whose label ends in an ellipsis when it is wider than the pop-up, with the
- * whole label in a tooltip on hover, as antd's Select. Its icon and description show as the
+ * whole label in a tooltip on hover. Its icon and description show as the
  * Selector's own option's. It holds no state.
  */
 export declare function TruncatedOption({ option }: TruncatedOptionProps): ReactNode;

package/dist/atoms/TruncatedOption.doc.d.ts

@@ -0,0 +1,24 @@
+/** Usage guidance for TruncatedOption. */
+export declare const doc: {
+    category: "Selection";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+        anatomy: ({
+            name: string;
+            required: true;
+            description: string;
+        } | {
+            name: string;
+            required: false;
+            description: string;
+        })[];
+    };
+};

package/dist/atoms/TruncatedText.doc.d.ts

@@ -0,0 +1,15 @@
+/** Usage guidance for TruncatedText. */
+export declare const doc: {
+    category: "Data display";
+    keywords: string[];
+    usage: {
+        description: string;
+        bestPractices: ({
+            guidance: true;
+            description: string;
+        } | {
+            guidance: false;
+            description: string;
+        })[];
+    };
+};