@emeraldemperaur/vector-sigma 1.4.17 → 1.4.19

package/lib/types/components/toggle/toggle.d.ts

@@ -3,16 +3,77 @@ import type { ButtonProps } from '@radix-ui/themes';
 import '../../styles/main.scss';
 export type ToggleDesign = 'toggle' | 'toggle-material' | 'toggle-outline' | 'toggle-neumorphic';
 interface ToggleProps extends ButtonProps {
-    inputtype?: ToggleDesign & {};
+    /**
+       * * The required unique identifier for the Toggle input field in useFormikContext().
+       * Alias referenced as `name` attribute and Formik state key.
+       * * @example
+       * alias="numberOfRentalRooms"
+       */
     alias: string;
+    /**
+       * * The design variation of the Toggle input field.
+       * Default: 'slider-outline'
+       * Variants: 'slider', 'slider-outline', 'slider-material', 'slider-neumorphic'.
+       * * @example
+       * inputtype="slider-neumorphic"
+       */
+    inputtype?: ToggleDesign & {};
+    /**
+       * * The optional input label or description for the Toggle input field.
+       * * @example
+       * inputLabel="Enable VΣ AI Insights"
+       */
     inputLabel?: string;
+    /**
+       * * The required viewport column width for the Toggle input field.
+       * i.e. 1 - 12
+       * * @example
+       * width={5}
+       */
     width: number;
+    /**
+       * * Option to render Toggle input field on new row.
+       * * @example
+       * newRow
+       */
     newRow?: boolean;
+    /**
+       * * Option to disable edits for Toggle input field.
+       * * @example
+       * readOnly
+       */
     readOnly?: boolean;
+    /**
+         * * Option to enable a hint for Toggle input field.
+         * * @example
+         * isHinted
+         */
     isHinted?: boolean;
+    /**
+       * * Option to specify hint text for Toggle input field.
+       * * @example
+       * hintText="This is a hint for a VΣ Toggle input"
+       */
     hintText?: string;
+    /**
+       * * Option to specify a hint url reference or resource for Toggle input field.
+       * * @example
+       * hintUrl="https://www.mekaegwim.ca"
+       */
     hintUrl?: string;
+    /**
+       * * Option to specify an Icon name for Toggle input field.
+       * e.g. `sun`, `moon`
+       * Defaults to `stack` icon if `name` not provided
+       * * @example
+       * icon="star"
+       */
     icon?: string;
+    /**
+       * * Option to specify the isRequired error text for the Toggle input field.
+       * * @example
+       * errorText="A toggled selection is required"
+       */
     errorText?: ReactNode | string | null;
 }
 export declare const Toggle: ({ inputtype, alias, readOnly, width, inputLabel, style, children, newRow, isHinted, hintText, hintUrl, errorText, icon, ...props }: ToggleProps) => React.JSX.Element;

package/lib/types/components/xtitle/xtitle.d.ts

@@ -1,19 +1,91 @@
 import React from "react";
 import '../../styles/main.scss';
 interface TitleProps {
+    /**
+     * * The required title text for the SectionTitle component.
+     * * @example
+     * title="VΣ User Questionnaire"
+     */
     title: string;
+    /**
+     * * The required viewport column width for the Toggle input field.
+     * i.e. 1 - 12
+     * * @example
+     * width={5}
+     */
     width?: number;
+    /**
+     * * Option to render Toggle input field on new row.
+     * * @example
+     * newRow
+     */
     newRow?: boolean;
+    /**
+     * * Option to specify a title font size.
+     * * @example
+     * size="2"
+     */
     size?: "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
-    subsize?: "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
+    /**
+    * * Option to specify a subtitle text for the SectionTitle component.
+    * * @example
+    * subTitle="VΣ AI Reserch Group"
+    */
     subTitle?: string;
+    /**
+     * * Option to specify a subtitle font size.
+     * * @example
+     * subsize="1"
+     */
+    subsize?: "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
+    /**
+     * * Option to specify a title text alignment for the SectionTitle component.
+     * Default: "left"
+     * * @example
+     * align="right"
+     */
     align?: "left" | "center" | "right";
+    /**
+    * * Option to render a bottom visual separator for the SectionTitle component.
+    * * @example
+    * withSeparator
+    */
     withSeparator?: boolean;
+    /**
+     * * Option to specify the .scss class selector for the SectionTitle component.
+     * * @example
+     * className="teletraan-1-sectiontitle"
+     */
     className?: string;
+    /**
+     * * Option to specify the background color for the SectionTitle component.
+     * * @example
+     * backgroundColor="#800020"
+     */
     backgroundColor?: string;
+    /**
+   * * Option to render SectionTitle component with icon passed as a ReactNode {}.
+   * * @example
+   * icon={<Icon name="stack"/>}
+   */
     icon?: React.ReactNode;
+    /**
+     * * Option to specify the title text color for the SectionTitle component.
+     * * @example
+     * titleColor="#ffffff"
+     */
     titleColor?: string;
+    /**
+     * * Option to specify the subtitle text color for the SectionTitle component.
+     * * @example
+     * subtitleColor="#ffffff"
+     */
     subtitleColor?: string;
+    /**
+     * * Option to specify the title and subtitle text letter spacing (em) for the SectionTitle component.
+     * * @example
+     * letterSpacing="0.13em"
+     */
     letterSpacing?: string;
 }
 export declare const SectionTitle: ({ title, width, newRow, size, subsize, subTitle, align, letterSpacing, withSeparator, className, backgroundColor, icon, titleColor, subtitleColor }: TitleProps) => React.JSX.Element;

package/lib/types/layouts/column/column.d.ts

@@ -2,13 +2,57 @@ import React from 'react';
 import { Box } from '@radix-ui/themes';
 type ColSize = number | "auto" | boolean;
 type ColProps = React.ComponentProps<typeof Box> & {
+    /**
+       * * Option to specify a span number for the Column component.
+       * i.e. 1 - 12
+       * * @example
+       * span={6}
+       */
     span?: number;
+    /**
+       * * Option to render Column component on a line.
+       * * @example
+       * newRow
+       */
     newLine?: boolean;
+    /**
+      * * Option to enable or specify `xs` viewport column size/breakpoint.
+      * * @example
+      * xs={3}
+      */
     xs?: ColSize;
+    /**
+       * * Option to enable or specify `sm` viewport column size/breakpoint.
+       * * @example
+       * sm={4}
+       */
     sm?: ColSize;
+    /**
+       * * Option to enable or specify `md` viewport column size/breakpoint.
+       * * @example
+       * md={5}
+       */
     md?: ColSize;
+    /**
+       * * Option to enable or specify `lg` viewport column size/breakpoint.
+       * * @example
+       * lg={6}
+       */
     lg?: ColSize;
+    /**
+       * * Option to enable or specify `xl` viewport column size/breakpoint.
+       * * @example
+       * xl={6}
+       */
     xl?: ColSize;
+    /**
+     * * Required Column child components.
+     * * @example
+     * children={
+     * <Text/>
+     * ......
+     * }
+     */
     children?: React.ReactNode;
 };
 export declare const Column: ({ newLine, span, xs, sm, md, lg, xl, children, ...props }: ColProps) => React.JSX.Element;

package/lib/types/layouts/container/container.d.ts

@@ -1,7 +1,22 @@
 import React from 'react';
 import type { ContainerProps as RadixContainerProps } from '@radix-ui/themes';
 interface ContainerProps extends RadixContainerProps {
+    /**
+       * * Option to enable fluid container width style for the Container component.
+       * i.e. 1 - 12
+       * * @example
+       * width={5}
+       */
     fluid?: boolean;
+    /**
+      * * Required Container child components.
+      * * @example
+      * children={
+      * <Row>
+      * <Col><Col>
+      * </Row>
+      * }
+      */
     children: React.ReactNode;
 }
 export declare const Container: ({ fluid, children, ...props }: ContainerProps) => React.JSX.Element;

package/lib/types/layouts/row/row.d.ts

@@ -1,7 +1,27 @@
 import React from 'react';
 interface RowProps {
+    /**
+       * * Required Row child components.
+       * * @example
+       * children={
+       * <Col>
+       * <Text/>
+       * </Col>
+       * }
+       */
     children: React.ReactNode;
+    /**
+      * * Option to specify the .scss class selector for the Row component.
+      * * @example
+      * className="teletraan-1-row"
+      */
     className?: string;
+    /**
+       * * Option to specify a buffer spacing for child elements in the Row component.
+       * Default: "4"
+       * * @example
+       * gap="6"
+       */
     gap?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
 }
 export declare const Row: ({ children, className, gap }: RowProps) => React.JSX.Element;

package/lib/types/teletraan1.d.ts

@@ -1 +1,2 @@
-export declare const teletraan1: (name: String) => string;
+import { xForm } from "xForm";
+export declare const teletraan1: (xFormModel: xForm, readOnlyMode: boolean) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emeraldemperaur/vector-sigma",
-  "version": "1.4.17",
+  "version": "1.4.19",
   "description": "Dynamic Form Orchestrator: NPM Package",
   "repository": {
     "type": "git",
@@ -28,7 +28,12 @@
     "prepublishOnly": "npm run build",
     "release-package": "npm run build && npx changeset publish",
     "test": "jest",
-    "test:watch": "jest --watch"
+    "test:fast": "jest --runInBand",
+    "test:watch": "jest --watch",
+    "test:leaks": "jest --detectOpenHandles",
+    "test:changed": "jest --onlyChanged",
+    "test:bail": "jest --bail",
+    "test:ci": "jest --maxWorkers=50% --ci"
   },
   "devDependencies": {
     "@changesets/cli": "^2.29.8",