@trackunit/react-components 0.1.175 → 0.1.176

package/src/components/Card/Card.d.ts

@@ -26,7 +26,7 @@ export interface CardProps extends CommonProps, React.InputHTMLAttributes<HTMLDi
 /**
  * The Card component is a container for UI elements, and is the main component of the modal.
  * To get the most out of the Card, use it in combination with the CardHeader, CardBody and CardFooter.
- *
+ 
  * @param {CardProps} props - The props for the Card component
  * @returns {JSX.Element} Card component
  */

package/src/components/Card/CardFooter.d.ts

@@ -18,7 +18,7 @@ export interface CardFooterProps extends CommonProps {
  * A simple footer intended to use with Cards and Modals.
  * Currently only intended to contain Buttons.
  * The buttons justifies to the right, but if you style a button with "margin-right: auto" it will move to the left
- *
+ 
  * @param {CardFooterProps} props - The props for the CardFooter component
  * @returns {JSX.Element} CardFooter component
  */

package/src/components/Card/CardHeader.d.ts

@@ -40,7 +40,7 @@ export interface CardHeaderProps extends CommonProps {
 }
 /**
  * Header for Cards and Modals.
- *
+ 
  * @param {CardHeaderProps} props - The props for the CardHeader component
  * @returns {JSX.Element} CardHeader component
  */

package/src/components/Collapse/Collapse.d.ts

@@ -25,7 +25,7 @@ export interface CollapseProps extends CommonProps {
 }
 /**
  * The Collapse component is used to condense non-important information.
- *
+ 
  * @param {CollapseProps} props - The props for the Collapse component
  * @returns {JSX.Element} Collapse component
  */

package/src/components/CopyableText/CopyableText.d.ts

@@ -14,7 +14,7 @@ export interface CopyableTextProps extends CommonProps {
 }
 /**
  * The CopyableText component is used where the user should have easy access to copy information.
- *
+ 
  * @param {CopyableTextProps} props - The props for the CopyableText component
  * @returns {JSX.Element} CopyableText component
  */

package/src/components/DayPicker/DayPicker.d.ts

@@ -25,7 +25,7 @@ export interface DayPickerProps extends CommonProps {
 }
 /**
  * The DayPicker component is used when the user needs to select a date.
- *
+ 
  * @param {DayPickerProps} props - The props for the DayPicker component
  * @returns {JSX.Element} DayPicker component
  */

package/src/components/DayPicker/DayPickerPopover.d.ts

@@ -15,7 +15,7 @@ export interface DayPickerPopoverProps extends CommonProps {
 }
 /**
  * The DayPickerPopover component returns a button which when clicked shows the daypicker.
- *
+ 
  * @param {DayPickerPopoverProps} props - The props for the DayPickerPopover component
  * @returns {JSX.Element} DayPickerPopover component
  */

package/src/components/DayPicker/DayRangePicker.d.ts

@@ -26,7 +26,7 @@ export interface DayRangePickerProps extends CommonProps {
 }
 /**
  * The DayRangePicker component should be used when the user needs to select a range of dates.
- *
+ 
  * @param {DayRangePickerProps} props - The props for the DayRangePicker component
  * @returns {JSX.Element} DayRangePicker component
  */

package/src/components/Drawer/Drawer.d.ts

@@ -25,7 +25,7 @@ export interface DrawerProps extends CommonProps {
 }
 /**
  * The drawer provides a slideover which can be used to provide access to different locations in the application.
- *
+ 
  * @param {DrawerProps} props - The props for the Drawer component
  * @returns {JSX.Element} Drawer component
  */

package/src/components/EmptyState/EmptyState.d.ts

@@ -14,7 +14,7 @@ export interface EmptyStateProps extends CommonProps {
  * Component representing an empty state.
  * Use this component when there is no data to display or when an error occurs.
  *
- *
+ 
  * @param {EmptyStateProps} props props
  * @returns {JSX.Element} component
  * @example

package/src/components/ExternalLink/ExternalLink.d.ts

@@ -25,7 +25,7 @@ export interface ExternalLinkProps extends CommonProps {
 }
 /**
  *  The external link component is used to link to an external page outside the Trackunit Manager.
- *
+ 
  * @param {ExternalLinkProps} props - The props for the external link component
  * @returns {JSX.Element} External Link component
  */

package/src/components/Heading/Heading.d.ts

@@ -21,7 +21,7 @@ export interface HeadingProps extends CommonProps {
 }
 /**
  * The Heading is used for a heading of a section (h1,h2,h3,h4).
- *
+ 
  * @param {HeadingProps} props - The props for the Heading component
  * @returns {JSX.Element} Heading component
  */

package/src/components/Icon/Icon.d.ts

@@ -298,7 +298,7 @@ export interface IconProps extends CommonProps {
  * - The Icon component is used to display an Icon.
  * - Icons are semantic vector graphics that adds character and improves the visual appeal of elements when combined with.
  * - All the [HeroIcons](https://heroicons.dev/) as well as custom Trackunit icons are available.
- *
+ 
  * @param {IconProps} props - The props for the Icon component
  * @returns {JSX.Element} Icon component
  */

package/src/components/Indicator/Indicator.d.ts

@@ -35,7 +35,7 @@ export interface IndicatorProps extends CommonProps {
  * _**Do use** indicators to communicate essential aspects of the state of an asset._
  *
  * _**Do not use** indicators for non-essential information, or to communicate information unrelated to the state of an asset._
- *
+ 
  * @param {IndicatorProps} props - The props for the Indicator component
  * @returns {JSX.Element} Indicator component
  */

package/src/components/Menu/MenuItem/MenuItem.d.ts

@@ -56,7 +56,7 @@ export interface MenuItemProps extends CommonProps {
 }
 /**
  * The MenuItem component is used to display a menu, primarily meant to be used in a list form.
- *
+ 
  * @param {MenuItemProps} props - The props for the MenuItem component
  * @returns {JSX.Element} MenuItem component
  */

package/src/components/Menu/MenuList/MenuList.d.ts

@@ -22,7 +22,7 @@ export interface MenuListProps extends CommonProps {
 }
 /**
  * The MenuList component is used for menus and selects.
- *
+ 
  * @param {MenuListProps} props - The props for the MenuList component
  * @returns {JSX.Element} MenuList component
  */

package/src/components/Modal/Modal.d.ts

@@ -26,5 +26,6 @@ export interface ModalProps extends CommonProps {
  * - Modals are used to present critical information or request user input needed to complete a user's workflow.
  * - Modals interrupt a user's workflow by design.
  * - The modal component provides a foundation for creating dialogs, lightboxes, etc.
+ 
  */
 export declare const Modal: React.ForwardRefExoticComponent<ModalProps & React.RefAttributes<HTMLDivElement>>;

package/src/components/Modal/ModalBackdrop.d.ts

@@ -6,7 +6,7 @@ export interface ModalBackdropProps {
 }
 /**
  * The Backdrop for the modal.
- *
+ 
  * @param {ModalBackdropProps} props - The props for the ModalBackdrop component
  * @returns {JSX.Element} ModalBackdrop component
  */

package/src/components/Modal/useModal.d.ts

@@ -5,7 +5,7 @@ export interface UseModalProps {
 }
 /**
  * The useModal component should be used to inform the user of important information.
- *
+ 
  * @param {UseModalProps} props - The props for the useModal hook
  * @returns {*} useModal return
  */

package/src/components/PageHeader/PageHeader.d.ts

@@ -45,7 +45,7 @@ export interface PageHeaderProps extends CommonProps {
  * Pageheader component is used to display a page header.
  *
  * PageHeader can be used to highlight the page topic, display important information about the page, and carry the action items related to the current page.
- *
+ 
  * @param {PageHeaderProps} props - The props for the PageHeader component
  * @returns {JSX.Element} PageHeader component
  */

package/src/components/Pagination/Pagination.d.ts

@@ -55,7 +55,7 @@ export interface IPaginationProps {
 }
 /**
  * Pagination Description. It could be used when you need navigation for your paging feature.
- *
+ 
  * @param {IPaginationProps} props - The props for the Pagination component
  * @returns {JSX.Element} Pagination component
  */

package/src/components/Popover/Popover.d.ts

@@ -68,7 +68,7 @@ export declare const usePopoverContext: () => {
  *
  * To render the content of the popover, use the `<PopoverContent />` component.
  *
- *
+ 
  * @param {PopoverProps} props The props for the popover
  * @returns {JSX.Element} A Popover Context Provider containing the children
  */

package/src/components/Popover/PopoverTitle.d.ts

@@ -13,7 +13,7 @@ export interface PopoverTitleProps extends CommonProps {
 }
 /**
  * The PopoverTitle component.
- *
+ 
  * @param {PopoverTitleProps} props - The props for the PopoverTitle component
  * @returns {JSX.Element} PopoverTitle component
  */

package/src/components/Prompt/Prompt.d.ts

@@ -4,7 +4,7 @@ interface PromptProps {
 }
 /**
  * The usePrompt hook.
- *
+ 
  * @param {string} message -
  * @param {boolean} when -
  * @returns {void} void

package/src/components/SectionHeader/SectionHeader.d.ts

@@ -16,7 +16,7 @@ export interface SectionHeaderProps extends CommonProps {
 }
 /**
  * The SectionHeader component is used on sections to set the section title.
- *
+ 
  * @param {SectionHeaderProps} props - The props for the section header component
  * @returns {JSX.Element} SectionHeader component
  */

package/src/components/Sidebar/Sidebar.d.ts

@@ -50,7 +50,7 @@ export interface SidebarProps extends CommonProps {
  * - **_The sidebar is just a wrapper. You are responsible for styling the children._**
  *
  * When using this component make sure to add `setupIntersectionObserver();` to your jest.setup.ts file.
- *
+ 
  * @param {SidebarProps} props - The props for the Sidebar component
  * @returns {JSX.Element} Sidebar component
  */

package/src/components/SkeletonLines/SkeletonLines.d.ts

@@ -20,6 +20,7 @@ export interface SkeletonLinesProps extends CommonProps {
 }
 /**
  * Display placeholder lines before the data gets loaded to reduce load-time frustration.
+ 
  */
 export declare const SkeletonLines: import("react").MemoExoticComponent<({ margin, lines, height, width, className, dataTestId }: SkeletonLinesProps) => JSX.Element>;
 export default SkeletonLines;

package/src/components/Spacer/Spacer.d.ts

@@ -13,7 +13,7 @@ export interface SpacerProps extends CommonProps {
 }
 /**
  * The Spacer component is used for adding a bit of space in the ui.
- *
+ 
  * @param {SpacerProps} props - The props for the Spacer component
  * @returns {JSX.Element} Spacer component
  */

package/src/components/Spinner/Spinner.d.ts

@@ -31,7 +31,7 @@ export interface SpinnerProps extends CommonProps {
  * Use a spinner component for any action that cannot be performed instantly and will only require a short time (between 1 to 5 seconds) to process.
  *
  * Use when retrieving or refreshing small data amounts, such as status.
- *
+ 
  * @param {SpinnerProps} props - The props for the Spinner component
  * @returns {JSX.Element} Spinner component
  */

package/src/components/Tag/Tag.d.ts

@@ -37,7 +37,7 @@ export interface TagProps extends CommonProps {
  *  The tag is also used in multiselect components to show selected options.
  *
  *  **Do:** Use short labels for easy scanning.
- *
+ 
  * @param {TagProps} props - The props for the tag component
  * @returns {JSX.Element} tag component
  */

package/src/components/Text/Text.d.ts

@@ -55,7 +55,7 @@ export interface TextProps extends CommonProps {
  *  ### When to use
  *
  *  Use Text when you want to show a text section, use Heading if you want to show a heading.
- *
+ 
  * @param {TextProps} props - The props for the Text component
  * @returns {JSX.Element} Text component
  */

package/src/components/Timeline/Timeline.d.ts

@@ -8,7 +8,7 @@ export interface TimelineProps extends CommonProps {
  * - with an indicator (dot)
  * - a header (next to the dot)
  * - and a body.
- *
+ 
  * @param {TimelineProps} props - The props for the Timeline component
  * @returns {JSX.Element} Timeline component
  */

package/src/components/Tip/Tip.d.ts

@@ -19,7 +19,7 @@ export interface TipProps extends CommonProps, Pick<TooltipProps, "placement" |
 /**
  * The Tip component is used to show helpful tips or contextual information to the users.
  * The tip can optionally be rendered as an anchor tag, which redirects to users to an external link on click.
- *
+ 
  * @param {TipProps} props - The props for the Tip component
  * @returns {JSX.Element} Tip component
  */

package/src/components/Tooltip/Tooltip.d.ts

@@ -30,7 +30,7 @@ export interface TooltipProps extends CommonProps {
 }
 /**
  * The Tooltip component is used to show helpful tips or contextual information to the users.
- *
+ 
  * @param {TooltipProps} props - The props for the Tooltip component
  * @returns {JSX.Element} Tooltip component
  */

package/src/components/ValueBar/ValueBar.d.ts

@@ -39,7 +39,7 @@ export interface ValueBarProps extends CommonProps {
 }
 /**
  * ValueBar component is used to display value on a colorful bar within provided range.
- *
+ 
  * @param {ValueBarProps} props - The props for the ValueBar component
  * @returns {JSX.Element} ValueBar component
  */

package/src/components/ValueBar/ValueBarHelper.d.ts

@@ -1,7 +1,7 @@
 import { LevelColors } from "./ValueBarTypes";
 /**
  * Helper function to get normalized score in range 0-1 used by the ValueBar
- *
+ 
  * @param {number} value - value for which score should be returned
  * @param {number} min - min range value
  * @param {number} max - max range value
@@ -10,14 +10,14 @@ import { LevelColors } from "./ValueBarTypes";
 export declare const getScore: (value: number, min: number, max: number) => number;
 /**
  * Helper function to get default color used by the ValueBar
- *
+ 
  * @param {number} score - score number for which color should be returned
  * @returns {string} color value
  */
 export declare const getDefaultFillColor: (score: number) => string;
 /**
  * Helper function to get custom color used by the ValueBar
- *
+ 
  * @param {number} score - score number for which color should be returned
  * @param {LevelColors} levelColors - custom colors and levels definitions
  * @returns {string} color value
@@ -25,7 +25,7 @@ export declare const getDefaultFillColor: (score: number) => string;
 export declare const getFillColor: (score: number, levelColors: LevelColors) => string;
 /**
  * Helper function to get color used by the ValueBar
- *
+ 
  * @param {number} value - value for which color should be returned
  * @param {number} min - min range value
  * @param {number} max - max range value

package/src/components/buttons/BackToTopButton/BackToTopButton.d.ts

@@ -9,6 +9,6 @@ export interface BackToTopProps extends CommonProps {
 }
 /**
  * BackToTopButton appears at the bottom-right corner of the screen when the user scrolls down the page. When clicked, the page scrolls smoothly to the top.
- *
+ 
  */
 export declare const BackToTopButton: ({ color, size, dataTestId, className }: BackToTopProps) => JSX.Element;

package/src/components/buttons/Button/Button.d.ts

@@ -37,7 +37,7 @@ export interface ButtonProps extends ButtonCommonProps {
 }
 /**
  * Buttons allow users to perform an action when triggered.
- *
+ 
  * @param {ButtonProps} props - The props for the Button component
  * @returns {JSX.Element} Button component
  */

package/src/components/buttons/IconButton/IconButton.d.ts

@@ -17,4 +17,7 @@ export interface IconButtonProps extends ButtonCommonProps {
      */
     size?: Size;
 }
+/**
+ * The IconButton is used for a button with an icon.
+ */
 export declare const IconButton: React.ForwardRefExoticComponent<IconButtonProps & React.RefAttributes<HTMLButtonElement>>;

package/src/components/buttons/StarButton/StarButton.d.ts

@@ -5,7 +5,7 @@ interface StarButtonProps {
 }
 /**
  * The StarButton component is used for favorite actions or similar.
- *
+ 
  * @param {StarButtonProps} props - The props for the StarButton component
  * @returns {JSX.Element} StarButton component
  */

package/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./common";
+export * from "./common/PackageNameStoryComponent";
 export * from "./components";
 export * from "./components/Clickable/Clickable.variants";
 export * from "./components/Indicator/Indicator.variants";