@kwantis-id3/frontend-library 1.0.0-rc.4 → 1.0.0-rc.6

package/dist/esm/types/components/Accordion/Accordion.d.ts

@@ -1,37 +1,3 @@
-/** @jsxImportSource @emotion/react */
-import { Interpolation } from "@emotion/styled";
 import React from "react";
-import { Theme } from "@emotion/react";
-export type AccordionProps = {
-    /** Text of the accordion trigger */
-    title: string;
-    /** Content of the accordion */
-    children: React.ReactNode;
-    /** Custom trigger component */
-    customTrigger?: React.ReactNode;
-    /** Works only if uncontrolled (isOpen props is not present) */
-    defaultOpen?: boolean;
-    /** Color of the accordion */
-    color?: string;
-    /** Color of the icon */
-    iconColor?: string;
-    /** Color of the divider */
-    dividerColor?: string;
-    /** Hide the icon */
-    hideIcon?: boolean;
-    /** Hide the divider */
-    hideDivider?: boolean;
-    /** Pass your state value here if the Accordion needs to be Controlled */
-    isOpen?: boolean;
-    /** Lazy render the content of the accordion */
-    isLazy?: boolean;
-    /** onClick handler */
-    onClick?: () => void;
-    /** onOpen handler */
-    onOpen?: () => void;
-    /** onClose handler */
-    onClose?: () => void;
-    /** Custom styles */
-    sx?: Interpolation<Theme>;
-};
-export declare const Accordion: (props: AccordionProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+import { TAccordionProps } from "./AccordionInterfaces";
+export declare const Accordion: React.FC<TAccordionProps>;

package/dist/esm/types/components/Accordion/AccordionInterfaces.d.ts

@@ -0,0 +1,21 @@
+import React, { PropsWithChildren } from "react";
+export type TAccordionProps = PropsWithChildren & {
+    /** Title to be used if no custom trigger is passed */
+    title: string;
+    /** Pass your state value here if the Accordion needs to be Controlled */
+    isOpen?: boolean;
+    /** Default open state if the accordion is Uncontrolled */
+    defaultOpen?: boolean;
+    /** Callback function to be called when the Accordion is clicked */
+    onClick?: () => void;
+    /** Callback function to be called when the Accordion opens */
+    onOpen?: () => void;
+    /** Callback function to be called when the Accordion closes */
+    onClose?: () => void;
+    /** Custom trigger element */
+    trigger?: (isOpen: boolean) => React.ReactNode;
+    /** Variant of the Accordion. Default has everything wrapped in borders, while light just renders the content and the title without setting colors
+     * @default "default"
+     */
+    variant?: "default" | "light";
+};

package/dist/esm/types/components/Accordion/AccordionStyled.d.ts

@@ -1,23 +1,32 @@
-export declare const Divider: import("@emotion/styled").StyledComponent<{
+export declare const AccordionGroup: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;
     as?: React.ElementType;
-} & {
-    $color: string;
 }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
-export declare const TitleDiv: import("@emotion/styled").StyledComponent<{
+export declare const StyledAccordion: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;
     as?: React.ElementType;
 } & {
-    $color: string;
-    $textColor: string;
+    $variant: "default" | "light";
+    $isOpen: boolean;
 }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
-export declare const IconContainer: import("@emotion/styled").StyledComponent<{
+export declare const StyledAccordionHeader: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;
     as?: React.ElementType;
 } & {
-    $iconColor: string;
+    $variant: "default" | "light";
+    $isOpen: boolean;
+}, import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, {}>;
+export declare const StyledAccordionContent: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme;
+    as?: React.ElementType;
+} & {
+    $isOpen: boolean;
+    $variant: "default" | "light";
+    $defaultHeight: string;
 }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
-export declare const TitleH2: import("@emotion/styled").StyledComponent<{
+export declare const Icon: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;
     as?: React.ElementType;
-}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, {}>;
+} & {
+    $isOpen: boolean;
+}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;

package/dist/esm/types/components/Accordion/index.d.ts

@@ -1 +1,2 @@
-export { Accordion, AccordionProps } from "./Accordion";
+export { Accordion } from "./Accordion";
+export * from "./AccordionInterfaces";

package/dist/esm/types/components/Button/Button.d.ts

@@ -12,6 +12,8 @@ export type ButtonProps = {
     sx?: Interpolation<Theme>;
     /** Variant of the button, either `contained`, `outlined` or `text` */
     variant?: ButtonVariants;
+    /** The button size; either "large" or "small" */
+    size?: "small" | "large";
     /** onClick handler */
     onClick?: () => void;
     className?: string;

package/dist/esm/types/components/InputField/InputField.d.ts

@@ -2,8 +2,6 @@ import React from "react";
 interface TextFieldProps extends React.InputHTMLAttributes<HTMLInputElement> {
     /** Classname given to the container div */
     containerClassName?: string;
-    /** Disables the input */
-    isDisabled?: boolean;
     /** The color of the input */
     color?: string;
     /** Change the styles of the input field */

package/dist/esm/types/components/TreeView/ControlledTreeView.d.ts

@@ -0,0 +1,4 @@
+/** @jsxImportSource @emotion/react */
+import { FC } from "react";
+import { TControlledTreeViewProps } from "./TreeViewInterfaces";
+export declare const ControlledTreeView: FC<TControlledTreeViewProps>;

package/dist/esm/types/components/TreeView/TreeUtils.d.ts

@@ -0,0 +1,3 @@
+import { TTreeViewItem } from "./TreeViewInterfaces";
+export declare const getRootItems: (items: TTreeViewItem[]) => TTreeViewItem[];
+export declare const getChildrenItems: (items: TTreeViewItem[], parentId: string) => TTreeViewItem[];

package/dist/esm/types/components/TreeView/TreeViewInterfaces.d.ts

@@ -0,0 +1,78 @@
+import { Interpolation, Theme } from "@emotion/react";
+import React from "react";
+/**
+ * A callback to customize how items are rendered
+ * @property isOpen: A boolean indicating if the item is expanded
+ * @property hasChildren: A boolean indicating if the item has children
+ * @property item: the entire item object
+ */
+export type TCustomRenderProps = {
+    isOpen: boolean;
+    item: TTreeViewItem;
+};
+/**
+ * A callback to customize how the content of the items is rendered
+ * @extends TCustomRenderProps
+ * @property icon: The icon of the item. If the renderIcon callback is provided, this will be the result of that callback
+ * @property title: The title of the item. If the renderTitle callback is provided, this will be the result of that callback
+ */
+export type TRenderTriggerProps = TCustomRenderProps & {
+    icon: React.ReactNode;
+    title: React.ReactNode;
+};
+type TTreeItemFunctions = {
+    /** A callback to customize how the titles are rendered */
+    renderTitle?: (props: TCustomRenderProps) => React.ReactNode;
+    /** A callback to customize how the icons are rendered */
+    renderIcon?: (props: TCustomRenderProps) => React.ReactNode;
+    /** A callback to customize how the content of the items is rendered */
+    renderTrigger?: (props: TRenderTriggerProps) => React.ReactNode;
+    /** A callback executed when an item is focused. An item gets focused when you click on it. Focusing and item will also select it. */
+    onFocusItem?: (item: TTreeViewItem) => void;
+    /** A callback executed when an item is selected. To select an item, ctrl+click on it. */
+    onSelectItems?: (item: string[]) => void;
+    /** A callback executed when an item is expanded */
+    onExpandItem?: (item: TTreeViewItem) => void;
+    /** A callback executed when an item is collapsed */
+    onCollapseItem?: (item: TTreeViewItem) => void;
+    /** A callback to handle the expansion of items without children */
+    onMissingChildren?: (item: TTreeViewItem) => void;
+};
+type TTreeViewProps = TTreeItemFunctions & {
+    /** An array representing the items that the tree needs to render */
+    items: TTreeViewItem[];
+    /** Disable multi-selection possibility */
+    isMultiSelectionDisabled?: boolean;
+    /** Custom styles */
+    sx?: Interpolation<Theme>;
+};
+export type TUncontrolledTreeViewProps = TTreeViewProps & {
+    items: TTreeViewItem[];
+};
+export type TControlledTreeViewProps = TTreeViewProps & {
+    /** The current state of the Tree View. */
+    viewState: TViewState;
+};
+export type TViewState = {
+    /** The list of ids of items that are selected */
+    selectedItems?: string[];
+    /** The list of ids of items that are expanded */
+    expandedItems?: string[];
+    /** The focused item */
+    focusedItem?: string;
+};
+export type TTreeViewItem = TTreeItemFunctions & {
+    /** Item identifier */
+    id: string;
+    /** Item name */
+    name: string;
+    /** The possible children of this item */
+    children?: string[];
+    /** If the item should be rendered as a folder even with no children */
+    isFolder?: boolean;
+    /** A callback to fetch children asynchronously */
+    childrenAsync?: () => Promise<TTreeViewItem[]>;
+    /** Custom styles */
+    sx?: Interpolation<Theme>;
+};
+export {};

package/dist/esm/types/components/TreeView/TreeViewSyled.d.ts

@@ -0,0 +1,24 @@
+export declare const TreeView: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme;
+    as?: React.ElementType;
+}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+export declare const TreeItemsWrapper: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme;
+    as?: React.ElementType;
+}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLUListElement>, HTMLUListElement>, {}>;
+export declare const TreeItemTrigger: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme;
+    as?: React.ElementType;
+} & {
+    $isFocused: boolean;
+    $isExpanded: boolean;
+    $isSelected: boolean;
+}, import("react").DetailedHTMLProps<import("react").LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, {}>;
+export declare const TreeItemChildren: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme;
+    as?: React.ElementType;
+} & import("react").ClassAttributes<HTMLUListElement> & import("react").HTMLAttributes<HTMLUListElement> & {
+    theme?: import("@emotion/react").Theme;
+} & {
+    $isExpanded: boolean;
+}, {}, {}>;

package/dist/esm/types/components/TreeView/UncontrolledTreeView.d.ts

@@ -0,0 +1,3 @@
+import { FC } from "react";
+import { TUncontrolledTreeViewProps } from "./TreeViewInterfaces";
+export declare const UncontrolledTreeView: FC<TUncontrolledTreeViewProps>;

package/dist/esm/types/components/TreeView/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./TreeViewInterfaces";
+export * from "./ControlledTreeView";
+export * from "./UncontrolledTreeView";

package/dist/esm/types/components/index.d.ts

@@ -1,6 +1,6 @@
 export { Button, ButtonProps } from "./Button";
 export * from "./ThemeContext";
-export { Accordion, AccordionProps } from "./Accordion";
+export { Accordion, TAccordionProps } from "./Accordion";
 export { InputField } from "./InputField";
 export { SingleSelect, SingleSelectProps, MultiSelect, MultiSelectProps, } from "./SelectFilter";
 export { Slider, SliderProps } from "./Slider";
@@ -11,3 +11,4 @@ export { Tag, TTagProps } from "./Tag";
 export { Card, CardHeader, CardContent, CardFooter, CardIndicators, CardMediaSection, TCardSectionProps, } from "./Card";
 export { Table, renderCell, TTableProps, TTableCell, TCellValues, TTableRow, } from "./Table";
 export { MultiViewList, TMultiViewListProps } from "./MultiViewList";
+export { ControlledTreeView, UncontrolledTreeView, TControlledTreeViewProps, TUncontrolledTreeViewProps, TViewState, TTreeViewItem, TCustomRenderProps, } from "./TreeView";

package/dist/esm/types/utils/colors.d.ts

@@ -6,15 +6,25 @@
 export declare const getContrastColor: (color: string) => string;
 /**
  *
- * @param color the color to darken
+ * @param color a color
  * @param strength the strength (0-100) to darken the color
  * @returns the color darkened by the strength
  */
 export declare const darkenColor: (color: string, strength?: number) => string;
 /**
  *
- * @param color the color to lighten
+ * @param color a color
  * @param strength the strength (0-100) to lighten the color
  * @returns the color lightened by the strength
  */
 export declare const lightenColor: (color: string, strength?: number) => string;
+/**
+ * @param color a color
+ * @returns the hover color, based on if the color is dark or light
+ */
+export declare const getHoverColor: (color: string) => string;
+/**
+ * @param color a color
+ * @returns the active color, based on if the color is dark or light
+ */
+export declare const getActiveColor: (color: string) => string;

package/dist/esm/types/utils/index.d.ts

@@ -2,6 +2,4 @@ import useIsMobile from "./isMobile";
 export { transientOptions } from "./transientOptions";
 export { styled } from "./styled";
 export { useIsMobile };
-export { getContrastColor } from "./colors";
-export { darkenColor } from "./colors";
-export { lightenColor } from "./colors";
+export { getContrastColor, darkenColor, lightenColor, getHoverColor, getActiveColor } from "./colors";

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _emotion_react_jsx_runtime from '@emotion/react/jsx-runtime';
 import * as React$1 from 'react';
-import React__default, { FC, PropsWithChildren } from 'react';
+import React__default, { PropsWithChildren, FC } from 'react';
 import { Interpolation, CreateStyled } from '@emotion/styled';
 import { Theme, Interpolation as Interpolation$1 } from '@emotion/react';
 import { ColumnDef } from '@tanstack/react-table';
@@ -15,6 +15,8 @@ type ButtonProps = {
     sx?: Interpolation<Theme>;
     /** Variant of the button, either `contained`, `outlined` or `text` */
     variant?: ButtonVariants;
+    /** The button size; either "large" or "small" */
+    size?: "small" | "large";
     /** onClick handler */
     onClick?: () => void;
     className?: string;
@@ -141,45 +143,32 @@ declare const defaultDarkPalette: IPalette;
 declare const ThemeContextProvider: ({ palettes, defaultMode, children, }: React__default.PropsWithChildren<IThemeContextProps>) => JSX.Element;
 declare const useThemeContext: () => IThemeContextValue;
 
-type AccordionProps = {
-    /** Text of the accordion trigger */
+type TAccordionProps = PropsWithChildren & {
+    /** Title to be used if no custom trigger is passed */
     title: string;
-    /** Content of the accordion */
-    children: React__default.ReactNode;
-    /** Custom trigger component */
-    customTrigger?: React__default.ReactNode;
-    /** Works only if uncontrolled (isOpen props is not present) */
-    defaultOpen?: boolean;
-    /** Color of the accordion */
-    color?: string;
-    /** Color of the icon */
-    iconColor?: string;
-    /** Color of the divider */
-    dividerColor?: string;
-    /** Hide the icon */
-    hideIcon?: boolean;
-    /** Hide the divider */
-    hideDivider?: boolean;
     /** Pass your state value here if the Accordion needs to be Controlled */
     isOpen?: boolean;
-    /** Lazy render the content of the accordion */
-    isLazy?: boolean;
-    /** onClick handler */
+    /** Default open state if the accordion is Uncontrolled */
+    defaultOpen?: boolean;
+    /** Callback function to be called when the Accordion is clicked */
     onClick?: () => void;
-    /** onOpen handler */
+    /** Callback function to be called when the Accordion opens */
     onOpen?: () => void;
-    /** onClose handler */
+    /** Callback function to be called when the Accordion closes */
     onClose?: () => void;
-    /** Custom styles */
-    sx?: Interpolation<Theme>;
+    /** Custom trigger element */
+    trigger?: (isOpen: boolean) => React__default.ReactNode;
+    /** Variant of the Accordion. Default has everything wrapped in borders, while light just renders the content and the title without setting colors
+     * @default "default"
+     */
+    variant?: "default" | "light";
 };
-declare const Accordion: (props: AccordionProps) => _emotion_react_jsx_runtime.JSX.Element;
+
+declare const Accordion: React__default.FC<TAccordionProps>;
 
 interface TextFieldProps extends React__default.InputHTMLAttributes<HTMLInputElement> {
     /** Classname given to the container div */
     containerClassName?: string;
-    /** Disables the input */
-    isDisabled?: boolean;
     /** The color of the input */
     color?: string;
     /** Change the styles of the input field */
@@ -456,6 +445,88 @@ type TMultiViewListProps<Cell extends TCellValues, Row extends TTableRow<Cell>>
 
 declare const MultiViewList: <Cell extends TCellValues, Row extends TTableRow<Cell>>(props: TMultiViewListProps<Cell, Row>) => _emotion_react_jsx_runtime.JSX.Element;
 
+/**
+ * A callback to customize how items are rendered
+ * @property isOpen: A boolean indicating if the item is expanded
+ * @property hasChildren: A boolean indicating if the item has children
+ * @property item: the entire item object
+ */
+type TCustomRenderProps = {
+    isOpen: boolean;
+    item: TTreeViewItem;
+};
+/**
+ * A callback to customize how the content of the items is rendered
+ * @extends TCustomRenderProps
+ * @property icon: The icon of the item. If the renderIcon callback is provided, this will be the result of that callback
+ * @property title: The title of the item. If the renderTitle callback is provided, this will be the result of that callback
+ */
+type TRenderTriggerProps = TCustomRenderProps & {
+    icon: React__default.ReactNode;
+    title: React__default.ReactNode;
+};
+type TTreeItemFunctions = {
+    /** A callback to customize how the titles are rendered */
+    renderTitle?: (props: TCustomRenderProps) => React__default.ReactNode;
+    /** A callback to customize how the icons are rendered */
+    renderIcon?: (props: TCustomRenderProps) => React__default.ReactNode;
+    /** A callback to customize how the content of the items is rendered */
+    renderTrigger?: (props: TRenderTriggerProps) => React__default.ReactNode;
+    /** A callback executed when an item is focused. An item gets focused when you click on it. Focusing and item will also select it. */
+    onFocusItem?: (item: TTreeViewItem) => void;
+    /** A callback executed when an item is selected. To select an item, ctrl+click on it. */
+    onSelectItems?: (item: string[]) => void;
+    /** A callback executed when an item is expanded */
+    onExpandItem?: (item: TTreeViewItem) => void;
+    /** A callback executed when an item is collapsed */
+    onCollapseItem?: (item: TTreeViewItem) => void;
+    /** A callback to handle the expansion of items without children */
+    onMissingChildren?: (item: TTreeViewItem) => void;
+};
+type TTreeViewProps = TTreeItemFunctions & {
+    /** An array representing the items that the tree needs to render */
+    items: TTreeViewItem[];
+    /** Disable multi-selection possibility */
+    isMultiSelectionDisabled?: boolean;
+    /** Custom styles */
+    sx?: Interpolation$1<Theme>;
+};
+type TUncontrolledTreeViewProps = TTreeViewProps & {
+    items: TTreeViewItem[];
+};
+type TControlledTreeViewProps = TTreeViewProps & {
+    /** The current state of the Tree View. */
+    viewState: TViewState;
+};
+type TViewState = {
+    /** The list of ids of items that are selected */
+    selectedItems?: string[];
+    /** The list of ids of items that are expanded */
+    expandedItems?: string[];
+    /** The focused item */
+    focusedItem?: string;
+};
+type TTreeViewItem = TTreeItemFunctions & {
+    /** Item identifier */
+    id: string;
+    /** Item name */
+    name: string;
+    /** The possible children of this item */
+    children?: string[];
+    /** If the item should be rendered as a folder even with no children */
+    isFolder?: boolean;
+    /** A callback to fetch children asynchronously */
+    childrenAsync?: () => Promise<TTreeViewItem[]>;
+    /** Custom styles */
+    sx?: Interpolation$1<Theme>;
+};
+
+/** @jsxImportSource @emotion/react */
+
+declare const ControlledTreeView: FC<TControlledTreeViewProps>;
+
+declare const UncontrolledTreeView: FC<TUncontrolledTreeViewProps>;
+
 /**
  * Hook to check if the screen is mobile. The default breakpoint is 768px.
  * @param {number=} mobileBreakpoint breakpoint width to check against
@@ -482,17 +553,27 @@ declare const styled: CreateStyled;
 declare const getContrastColor: (color: string) => string;
 /**
  *
- * @param color the color to darken
+ * @param color a color
  * @param strength the strength (0-100) to darken the color
  * @returns the color darkened by the strength
  */
 declare const darkenColor: (color: string, strength?: number) => string;
 /**
  *
- * @param color the color to lighten
+ * @param color a color
  * @param strength the strength (0-100) to lighten the color
  * @returns the color lightened by the strength
  */
 declare const lightenColor: (color: string, strength?: number) => string;
+/**
+ * @param color a color
+ * @returns the hover color, based on if the color is dark or light
+ */
+declare const getHoverColor: (color: string) => string;
+/**
+ * @param color a color
+ * @returns the active color, based on if the color is dark or light
+ */
+declare const getActiveColor: (color: string) => string;
 
-export { Accordion, AccordionProps, Button, ButtonProps, Card, CardContent, CardFooter, CardHeader, CardIndicators, CardMediaSection, Dropdown, DropdownItem, DropdownProps, IBackgroundColors, ICommonColors, IIndicatorColors, IPalette, IStandardPaletteColor, ITagColors, IThemeContextProps, IThemeContextValue, Indicator, InputField, Modal, MultiSelect, MultiSelectProps, MultiViewList, SingleSelect, SingleSelectProps, Slider, SliderProps, TCardSectionProps, TCellValues, TColorScale, TIndicatorProps, TIndicatorVariants, TMultiViewListProps, TTableCell, TTableProps, TTableRow, TTagProps, TThemeMode, Table, Tag, ThemeContextProvider, darkenColor, defaultDarkPalette, defaultLightPalette, getContrastColor, lightenColor, renderCell, styled, transientOptions, useIsMobile, useThemeContext };
+export { Accordion, Button, ButtonProps, Card, CardContent, CardFooter, CardHeader, CardIndicators, CardMediaSection, ControlledTreeView, Dropdown, DropdownItem, DropdownProps, IBackgroundColors, ICommonColors, IIndicatorColors, IPalette, IStandardPaletteColor, ITagColors, IThemeContextProps, IThemeContextValue, Indicator, InputField, Modal, MultiSelect, MultiSelectProps, MultiViewList, SingleSelect, SingleSelectProps, Slider, SliderProps, TAccordionProps, TCardSectionProps, TCellValues, TColorScale, TControlledTreeViewProps, TCustomRenderProps, TIndicatorProps, TIndicatorVariants, TMultiViewListProps, TTableCell, TTableProps, TTableRow, TTagProps, TThemeMode, TTreeViewItem, TUncontrolledTreeViewProps, TViewState, Table, Tag, ThemeContextProvider, UncontrolledTreeView, darkenColor, defaultDarkPalette, defaultLightPalette, getActiveColor, getContrastColor, getHoverColor, lightenColor, renderCell, styled, transientOptions, useIsMobile, useThemeContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kwantis-id3/frontend-library",
-  "version": "1.0.0-rc.4",
+  "version": "1.0.0-rc.6",
   "description": "Kwantis frontend components collection",
   "scriptsComments": {
     "storybook": "Starts storybook in development mode",