@trackunit/react-components 0.0.52 → 0.0.55

package/components/{text → Text}/Text.d.ts

@@ -7,62 +7,42 @@ export declare type TextWeight = "default" | "thick" | "bold";
 export interface TextProps extends CommonProps {
     /**
      * Child nodes.
-     *
-     * @memberof TextProps
      */
     children: React.ReactNode;
     /**
      * Type of element. Element can be of types "p", "span", or "div".
-     *
-     * @memberof TextProps
      */
     type?: TextType;
     /**
      * Size of element. Values can be "default", "small", or "large".
-     *
-     * @memberof TextProps
      */
     size?: TextSize;
     /**
      * Alignment of the text. Values can be "left", "center", or "right".
-     *
-     * @memberof TextProps
      */
     align?: TextAlign;
     /**
      * Weight of the text. Values can be "default", "thick", or "bold".
-     *
-     * @memberof TextProps
      */
     weight?: TextWeight;
     /**
      * Whether font styles are inverted.
-     *
-     * @memberof TextProps
      */
     inverted?: boolean;
     /**
      * Whether font styles are subtle or not.
-     *
-     * @memberof TextProps
      */
     subtle?: boolean;
     /**
      * Whether text is italicized.
-     *
-     * @memberof TextProps
      */
     italicize?: boolean;
     /**
      * Whether text is uppercase.
-     *
-     * @memberof TextProps
      */
     uppercase?: boolean;
     /**
      * Whether text is underlined or not.
-     *
-     * @memberof TextProps
      */
     underline?: boolean;
 }

package/components/{textField → TextField}/TextField.d.ts

@@ -1,21 +1,24 @@
 import * as React from "react";
-import { FormGroupProps } from "../formGroup/FormGroup";
+import { FormGroupProps } from "../FormGroup/FormGroup";
 import { TextInputProps } from "../TextInput/TextInput";
 declare type FormGroupExposedProps = Pick<FormGroupProps, "label" | "tip" | "helpText" | "helpAddon">;
 export interface TextFieldProps extends TextInputProps, FormGroupExposedProps {
     /**
      * Set the Maximal length of the value for the input.
      * Adds a TextLenghtIndicator to the right of the helpText.
-     *
-     * @memberof TextFieldProps
      */
     maxLength?: number;
     /**
      * If a value is set, the field is rendered in its invalid state.
-     *
-     * @memberof TextFieldProps
      */
     errorMessage?: string;
 }
+/**
+ * Text fields enable the user to interact with and input content and data. This component can be used for long and short form entries. Allow the size of the text input box to reflect the length of the content you expect the user to enter.
+ *
+ * _**Do use** when the user has to input or edit simple text based information, such as metadata._
+ *
+ * _**Do not use** to confirm user actions, such as deleting. Use a checkbox for such flows._
+ */
 export declare const TextField: React.ForwardRefExoticComponent<TextFieldProps & React.RefAttributes<HTMLInputElement>>;
 export {};

package/components/TextInput/TextInput.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { BaseInputProps } from "../baseInput/BaseInput";
+import { BaseInputProps } from "../BaseInput/BaseInput";
 declare type BaseInputExposedProps = Omit<BaseInputProps, "type">;
 export interface TextInputProps extends BaseInputExposedProps {
 }

package/components/{tip → Tip}/Tip.d.ts

@@ -1,12 +1,10 @@
 import * as React from "react";
 import { CommonProps } from "../../common";
-import { IconProps } from "../icon/Icon";
-import { TooltipProps } from "../tooltip";
+import { IconProps } from "../Icon/Icon";
+import { TooltipProps } from "../Tooltip";
 export interface TipProps extends CommonProps {
     /**
      * Child nodes to render inside the tip.
-     *
-     * @memberof TipProps
      */
     children: React.ReactNode;
     iconProps?: Partial<IconProps>;

package/components/{tooltip → Tooltip}/Tooltip.d.ts

@@ -1,59 +1,41 @@
 import * as React from "react";
-import { PopoverPlacement } from "../popover";
-import { TextType } from "../text";
+import { PopoverPlacement } from "../Popover";
+import { TextType } from "../Text";
 export interface TooltipProps {
     /**
      * The text to be displayed in the tooltip.
-     *
-     * @memberof TooltipProps
      */
     label: string | React.ReactNode;
     /**
      * Where the tooltip should be placed.
-     *
-     * @memberof TooltipProps
      */
     placement?: PopoverPlacement;
     /**
      * Child nodes
-     *
-     * @memberof TooltipProps
      */
     children?: React.ReactNode;
     /**
      * Id of test component.
-     *
-     * @memberof TooltipProps
      */
     dataTestId?: string;
     /**
      * Whether the tooltip is disabled or not.
-     *
-     * @memberof TooltipProps
      */
     disabled?: boolean;
     /**
      *  To select either "light" or "dark" mode.
-     *
-     * @memberof TooltipProps
      */
     mode?: "light" | "dark";
     /**
      * Offset value of the tooltip.
-     *
-     * @memberof TooltipProps
      */
     offset?: [number, number];
     /**
      * Additional classes to the component.
-     *
-     * @memberof TooltipProps
      */
     className?: string;
     /**
      * Type of content.
-     *
-     * @memberof TooltipProps
      */
     contentTextType?: TextType;
 }

package/components/buttons/{button → Button}/Button.d.ts

@@ -11,38 +11,26 @@ export interface ButtonProps extends ButtonCommonProps {
     onClick?: (event: React.MouseEvent<HTMLElement>) => void;
     /**
      * Child nodes. Can be used to pass in text to be displayed on the button.
-     *
-     * @memberof ButtonProps
      */
     children?: React.ReactNode;
     /**
      * Whether button is fullWidth or not.
-     *
-     * @memberof ButtonProps
      */
     fullWidth?: boolean;
     /**
      * The button prefix.
-     *
-     * @memberof ButtonProps
      */
     prefix?: React.ReactNode;
     /**
      * The button suffix.
-     *
-     * @memberof ButtonProps
      */
     suffix?: React.ReactNode;
     /**
      * The type of the button. Values can be "submit" or "button".
-     *
-     * @memberof ButtonProps
      */
     type?: ButtonType;
     /**
      * The element type the button will be rendered as.
-     *
-     * @memberof ButtonProps
      */
     renderAs?: keyof JSX.IntrinsicElements | React.ComponentType<any>;
     /**

package/components/buttons/{icon-button → IconButton}/IconButton.d.ts

@@ -3,14 +3,10 @@ import { ButtonCommonProps, ButtonSize } from "../shared/ButtonProps";
 export interface IconButtonProps extends ButtonCommonProps {
     /**
      * The icon to display.
-     *
-     * @memberof IconButtonProps
      */
     icon: React.ReactNode;
     /**
      * Whether the button is circular or not.
-     *
-     * @memberof IconButtonProps
      */
     circular?: boolean;
     /**
@@ -22,8 +18,6 @@ export interface IconButtonProps extends ButtonCommonProps {
     renderAs?: keyof JSX.IntrinsicElements | React.ComponentType<any>;
     /**
      * The size of the button. Defaults to "small".
-     *
-     * @memberof IconButtonProps
      */
     size?: ButtonSize;
 }

package/components/buttons/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./button/Button";
-export * from "./icon-button/IconButton";
+export * from "./Button/Button";
+export * from "./IconButton/IconButton";
 export * from "./shared/ButtonProps";
-export * from "./star-button/StarButton";
+export * from "./StarButton/StarButton";

package/components/buttons/shared/ButtonProps.d.ts

@@ -8,44 +8,30 @@ export interface ButtonCommonProps extends CommonProps {
     onClick?: (event: React.MouseEvent<HTMLElement>) => void;
     /**
      * Whether the button is loading.
-     *
-     * @memberof ButtonCommonProps
      */
     loading?: boolean;
     /**
      * Whether the button is disabled.
-     *
-     * @memberof ButtonCommonProps
      */
     disabled?: boolean;
     /**
      * Button with square aspect ratio.
-     *
-     * @memberof ButtonCommonProps
      */
     square?: boolean;
     /**
      * The button's variant. Values are filled, transparent, plain.
-     *
-     * @memberof ButtonCommonProps
      */
     intent?: ButtonIntent;
     /**
      * The variant of the button.
-     *
-     * @memberof ButtonCommonProps
      */
     variant?: ButtonVariant;
     /**
      * The size of the button.
-     *
-     * @memberof ButtonCommonProps
      */
     size?: ButtonSize;
     /**
      * The link to be used for the button.
-     *
-     * @memberof ButtonCommonProps
      */
     to?: string;
     title?: string;

package/components/buttons/shared/helpers.d.ts

@@ -1,4 +1,4 @@
-import { ButtonIntent, ButtonSize, ButtonVariant } from "../shared/ButtonProps";
+import { ButtonIntent, ButtonSize, ButtonVariant } from "./ButtonProps";
 interface ButtonProps {
     $intent: ButtonIntent;
     $variant: ButtonVariant;

package/components/index.d.ts

@@ -1,37 +1,38 @@
-export * from "./alert";
-export * from "./badge";
-export * from "./baseInput";
+export * from "./Alert";
+export * from "./Badge";
+export * from "./BaseInput";
 export * from "./buttons";
-export * from "./card";
-export * from "./chart";
-export * from "./checkbox";
-export * from "./collapse";
-export * from "./copyableText";
-export * from "./dateField";
-export * from "./dayPicker";
-export * from "./formGroup/FormGroup";
-export * from "./heading";
-export * from "./icon/Icon";
-export * from "./indicator";
-export * from "./label";
-export * from "./legendItem";
-export * from "./menu";
-export * from "./modal";
-export * from "./multiRowTableCell";
+export * from "./Card";
+export * from "./Chart";
+export * from "./Checkbox";
+export * from "./Collapse";
+export * from "./CopyableText";
+export * from "./DateField";
+export * from "./DayPicker";
+export * from "./FormGroup/FormGroup";
+export * from "./Heading";
+export * from "./Icon/Icon";
+export * from "./Indicator";
+export * from "./Label";
+export * from "./LegendItem";
+export * from "./Menu";
+export * from "./Modal";
+export * from "./MultiRowTableCell";
 export * from "./NumberField/NumberField";
 export * from "./NumberInput/NumberInput";
-export * from "./pageHeading";
-export * from "./popover";
-export * from "./prompt";
-export * from "./radioGroup";
-export * from "./select";
-export * from "./skeletonLines";
-export * from "./spacer";
-export * from "./spinner";
-export * from "./text";
-export * from "./textArea";
-export * from "./textField";
+export * from "./PageHeading";
+export * from "./Popover";
+export * from "./Prompt";
+export * from "./RadioGroup";
+export * from "./Select";
+export * from "./SkeletonLines";
+export * from "./Spacer";
+export * from "./Spinner";
+export * from "./Tag";
+export * from "./Text";
+export * from "./TextArea";
+export * from "./TextField";
 export * from "./TextInput/TextInput";
-export * from "./tip";
-export * from "./toggle";
-export * from "./tooltip";
+export * from "./Tip";
+export * from "./Toggle";
+export * from "./Tooltip";