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

package/dist/index.d.ts

@@ -1,42 +1,14 @@
 import * as _emotion_react_jsx_runtime from '@emotion/react/jsx-runtime';
 import * as React$1 from 'react';
-import React__default from 'react';
-import { Interpolation, CreateStyled as CreateStyled$1, CreateStyledComponent, FilteringStyledOptions, StyledOptions } from '@emotion/styled';
-import { Theme, PropsOf } from '@emotion/react';
-
-interface Color {
-    main: string;
-    contrastText: string;
-}
-interface ThemeColorsObject {
-    primary: Color;
-    secondary: Color;
-    tertiary: Color;
-    statusOk: Color;
-    statusWarning: Color;
-    statusCritical: Color;
-    statusNeutral: Color;
-}
-interface ThemeContextProps {
-    colors: ThemeColorsObject;
-}
-interface Nothing {
-}
-type Union<T, U> = T | (U & Nothing);
-type ThemeColors = keyof ThemeColorsObject;
-type ThemeColorsExtended = Union<ThemeColors, string>;
-type ThemeProperties = ThemeContextProps & {
-    getColor: (color: ThemeColorsExtended) => Color;
-};
-declare const ThemeContextProvider: (props: React__default.PropsWithChildren<{
-    theme?: ThemeContextProps;
-}>) => React__default.JSX.Element;
-declare const useThemeContext: () => ThemeProperties;
+import React__default, { FC, PropsWithChildren } from 'react';
+import { Interpolation, CreateStyled } from '@emotion/styled';
+import { Theme, Interpolation as Interpolation$1 } from '@emotion/react';
+import { ColumnDef } from '@tanstack/react-table';
 
 type ButtonVariants = "contained" | "outlined" | "text";
 type ButtonProps = {
     /** Color of the button */
-    color?: ThemeColorsExtended;
+    color?: string;
     /** Type of the button */
     type?: "button" | "submit" | "reset";
     /** Custom styles */
@@ -55,6 +27,120 @@ type ButtonProps = {
 };
 declare const Button: (props: ButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
 
+type TColorScale = {
+    50: string;
+    100: string;
+    200: string;
+    300: string;
+    400: string;
+    500: string;
+    600: string;
+    700: string;
+    800: string;
+    900: string;
+    950: string;
+};
+interface ICommonColors {
+    red: TColorScale;
+    green: TColorScale;
+    blue: TColorScale;
+    yellow: TColorScale;
+    purple: TColorScale;
+    darkBlue: TColorScale;
+    orange: TColorScale;
+    gray: TColorScale;
+}
+interface IBackgroundColors {
+    main: string;
+    radialGradient: string;
+}
+interface ISharedColorProperties {
+    /** Represents the color itself */
+    main: string;
+    /** A slightly different color derived from the main one */
+    variant: string;
+}
+interface IStandardPaletteColor extends ISharedColorProperties {
+    /** The color to be used for text and elements that need to contrast with the main / variant */
+    contrast: string;
+}
+interface ITagColors {
+    default: {
+        main: string;
+        text: string;
+    };
+    warm: {
+        main: string;
+        text: string;
+    };
+    cold: {
+        main: string;
+        text: string;
+    };
+    paper: {
+        main: string;
+        text: string;
+    };
+}
+interface IIndicatorColors {
+    main: string;
+    mainFill: string;
+    success: string;
+    successFill: string;
+    warning: string;
+    warningFill: string;
+    error: string;
+    errorFill: string;
+}
+interface IPalette {
+    /** Application background */
+    background: IBackgroundColors;
+    /** Primary Brand Color */
+    primary: IStandardPaletteColor;
+    /** Color config for actions solved with a success */
+    success: IStandardPaletteColor;
+    /** Color config for actions solved with a warning */
+    warning: IStandardPaletteColor;
+    /** Color config for actions solved with an error */
+    error: IStandardPaletteColor;
+    /** Color config for surfaces*/
+    surface: IStandardPaletteColor;
+    /** Color config for borders */
+    border: ISharedColorProperties;
+    /** Color config for tags */
+    tag: ITagColors;
+    /** Color config for indicators */
+    indicator: IIndicatorColors;
+}
+type TThemeMode = "light" | "dark" | "system";
+interface IThemeContextProps {
+    /** From this prop you can override (even partially) the palettes (dark and light) of the library. */
+    palettes?: {
+        light?: Partial<IPalette>;
+        dark?: Partial<IPalette>;
+    };
+    defaultMode?: TThemeMode;
+}
+interface IThemeContextValue {
+    /** Which mode is currently active */
+    mode: TThemeMode;
+    /** Which mode is currently displayed.
+     * This is useful when the mode is set to "system" and the user has a dark mode preference.
+     */
+    displayedMode: "light" | "dark";
+    /** A collection of common Colors with variants */
+    commonColors: ICommonColors;
+    /** This will contain the palette of the correct color mode. */
+    activePalette: IPalette;
+    /** use this function to change the mode */
+    setMode: (mode: TThemeMode) => void;
+}
+
+declare const defaultLightPalette: IPalette;
+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 */
     title: string;
@@ -65,11 +151,11 @@ type AccordionProps = {
     /** Works only if uncontrolled (isOpen props is not present) */
     defaultOpen?: boolean;
     /** Color of the accordion */
-    color?: ThemeColorsExtended;
+    color?: string;
     /** Color of the icon */
-    iconColor?: ThemeColorsExtended;
+    iconColor?: string;
     /** Color of the divider */
-    dividerColor?: ThemeColorsExtended;
+    dividerColor?: string;
     /** Hide the icon */
     hideIcon?: boolean;
     /** Hide the divider */
@@ -95,7 +181,7 @@ interface TextFieldProps extends React__default.InputHTMLAttributes<HTMLInputEle
     /** Disables the input */
     isDisabled?: boolean;
     /** The color of the input */
-    color?: ThemeColorsExtended;
+    color?: string;
     /** Change the styles of the input field */
     sx?: React__default.CSSProperties;
 }
@@ -130,7 +216,7 @@ interface SingleSelectProps<Option = {
     /** Wether the select is loading */
     isLoading?: boolean;
     /** The color of the select */
-    color?: ThemeColorsExtended;
+    color?: string;
     /** The HTML id of the container */
     containerId?: string;
     /** The HTML id of the select */
@@ -144,7 +230,7 @@ interface SingleSelectProps<Option = {
     /** Wether the select is required */
     required?: boolean;
 }
-declare const SingleSelect: <Option>(props: SingleSelectProps<Option>) => React__default.JSX.Element;
+declare const SingleSelect: <Option>(props: SingleSelectProps<Option>) => _emotion_react_jsx_runtime.JSX.Element;
 
 interface MultiSelectProps<Option = {
     label: string;
@@ -175,7 +261,7 @@ interface MultiSelectProps<Option = {
     /** Wether the select is loading */
     isLoading?: boolean;
     /** The color of the select */
-    color?: ThemeColorsExtended;
+    color?: string;
     /** The HTML id of the container */
     containerId?: string;
     /** The HTML id of the select */
@@ -187,7 +273,7 @@ interface MultiSelectProps<Option = {
     /** Wether the select is required */
     required?: boolean;
 }
-declare const MultiSelect: <Option>(props: MultiSelectProps<Option>) => React__default.JSX.Element;
+declare const MultiSelect: <Option>(props: MultiSelectProps<Option>) => _emotion_react_jsx_runtime.JSX.Element;
 
 type SliderProps = {
     /** The values of the slider. */
@@ -201,11 +287,11 @@ type SliderProps = {
     /** The onFinalChange handler of the slider. (called only when the thumb is released) */
     onFinalChange?: (values: number[]) => void;
     /** The color of the slider */
-    color?: ThemeColorsExtended;
+    color?: string;
     /** The color of the section not included in the range */
-    unselectedColor?: ThemeColorsExtended;
+    unselectedColor?: string;
     /** The color of the thumb */
-    thumbColor?: ThemeColorsExtended;
+    thumbColor?: string;
     /** The HTML id of the slider */
     htmlId?: string;
     /** The class name of the slider */
@@ -221,11 +307,11 @@ type SliderProps = {
     /** Wether the thumbs can overlap */
     allowOverlap?: boolean;
 };
-declare const Slider: (props: SliderProps) => React__default.JSX.Element;
+declare const Slider: (props: SliderProps) => _emotion_react_jsx_runtime.JSX.Element;
 
 /**
  * @property {string} value - The value displayed in the dropdown item
- * @property {ThemeColorsExtended} color - The color of the dropdown item
+ * @property {string} color - The color of the dropdown item
  * @property {string} textColor - The text color of the dropdown item
  * @property {DropdownItem[]} children - The children of the dropdown item
  * @property {() => void} onClick - The onClick handler of the dropdown item
@@ -234,9 +320,11 @@ type DropdownItem = {
     /** The value displayed in the item */
     value: string;
     /** The color of the item */
-    color?: ThemeColorsExtended;
+    bgColor?: string;
     /** The text color of the item */
     textColor?: string;
+    /** The hover color of the item */
+    hoverColor?: string;
     /** The children of the item */
     children?: DropdownItem[];
     /** Wether the item is hidden or not */
@@ -252,9 +340,9 @@ type DropdownProps = {
     /** The trigger element of the dropdown. Clicking on this item will open the dropdown */
     trigger: React__default.ReactNode;
     /** The color of the dropdown */
-    color?: ThemeColorsExtended;
+    bgColor?: string;
     /** The hover color of the dropdown */
-    hoverColor?: ThemeColorsExtended;
+    hoverColor?: string;
     /** Controls wether the dropdown should extend towards the left or the right */
     direction?: "left" | "right";
     /** The mobile breakpoint, by default it's 768px */
@@ -280,6 +368,94 @@ interface ModalProps {
 }
 declare const Modal: React__default.FC<ModalProps>;
 
+type TIndicatorInstanceProps = {
+    outerColor?: string;
+    innerColor?: string;
+    size?: number;
+    title?: string;
+    onClick?: (e: React.MouseEvent<SVGSVGElement>) => void;
+};
+type TIndicatorProps = {
+    variant: TIndicatorVariants;
+} & TIndicatorInstanceProps;
+type TIndicatorVariants = "live" | "success" | "warning" | "error";
+
+type TGenericIndicatorProps = {
+    variant: TIndicatorVariants;
+} & TIndicatorProps;
+declare const Indicator: FC<TGenericIndicatorProps>;
+
+type TTagProps = {
+    text: string;
+    /**
+     * If `variant` is set to `custom`, `bgColor` and `textColor` will be used.
+     * Otherwise, the `variant` will be used to determine the colors.
+     *
+     * The variants are the keys of the interface `@see ITagColors`, which by default are:
+     * - `default`
+     * - `warm`
+     * - `cold`
+     * - `paper`
+     */
+    variant: keyof ITagColors | "custom";
+    /** To use this prop, the variant must be set to `custom` */
+    bgColor?: string;
+    /** To use this prop, the variant must be set to `custom` */
+    textColor?: string;
+    sx?: Interpolation<Theme>;
+};
+declare const Tag: FC<TTagProps>;
+
+type TCardSectionProps = PropsWithChildren & {
+    sx?: Interpolation$1<Theme>;
+    onClick?: (e: React__default.MouseEvent<HTMLElement>) => void;
+};
+
+/** @jsxImportSource @emotion/react */
+
+/**
+ * The Card component is a container component that can be used to display content in a structured way.
+ * It has 3 possible sizes: small, medium and large.
+ *
+ */
+declare const Card: FC<TCardSectionProps>;
+declare const CardHeader: FC<TCardSectionProps>;
+declare const CardContent: FC<TCardSectionProps>;
+declare const CardFooter: FC<TCardSectionProps>;
+declare const CardIndicators: FC<TCardSectionProps>;
+declare const CardMediaSection: FC<TCardSectionProps>;
+
+type TCellValues = string | number | boolean | null;
+type TTableProps<Cell extends TCellValues, Row extends TTableRow<Cell>> = {
+    columns: ColumnDef<Row, Cell>[];
+    data: Row[] | undefined;
+};
+type TTableCell<T extends TCellValues> = {
+    value: T;
+    bgColor?: string | null;
+    textColor?: string | null;
+};
+type TTableRow<T extends TCellValues> = {
+    info?: {
+        bgColor?: string | null;
+        textColor?: string | null;
+        [key: string]: string | number | boolean | null | undefined;
+    };
+    cells: {
+        [key: string]: TTableCell<T>;
+    };
+};
+
+declare const Table: <Cell extends TCellValues, Row extends TTableRow<Cell>>(props: TTableProps<Cell, Row>) => _emotion_react_jsx_runtime.JSX.Element;
+declare const renderCell: (value: string | number | boolean | null) => _emotion_react_jsx_runtime.JSX.Element;
+
+type TMultiViewListProps<Cell extends TCellValues, Row extends TTableRow<Cell>> = TTableProps<Cell, Row> & {
+    mode: "table" | "cards";
+    cardComponent: (item: Row) => React__default.ReactNode;
+};
+
+declare const MultiViewList: <Cell extends TCellValues, Row extends TTableRow<Cell>>(props: TMultiViewListProps<Cell, Row>) => _emotion_react_jsx_runtime.JSX.Element;
+
 /**
  * Hook to check if the screen is mobile. The default breakpoint is 768px.
  * @param {number=} mobileBreakpoint breakpoint width to check against
@@ -287,42 +463,36 @@ declare const Modal: React__default.FC<ModalProps>;
  */
 declare const useIsMobile: (mobileBreakpoint?: number) => boolean;
 
-declare const transientOptions: Parameters<CreateStyled$1>[1];
+/**
+ * emotion.js doesn't support transient options out of the box.
+ *
+ * Without them, you will get a warning in the console for every custom prop that you pass to a styled component, since it will be forwarded to the DOM.
+ * This specific opt-in utility copies the styled-component approach; if used, props starting with `$` will not be passed to the DOM.
+ * @see https://github.com/emotion-js/emotion/issues/2193#issuecomment-766173118
+ */
+declare const transientOptions: Parameters<CreateStyled>[1];
 
-type StyledTags = {
-    [Tag in keyof JSX.IntrinsicElements]: CreateStyledComponent<{
-        theme?: ThemeContextProps;
-        as?: React.ElementType;
-    }, JSX.IntrinsicElements[Tag]>;
-};
-interface BaseCreateStyled {
-    <C extends React.ComponentClass<React.ComponentProps<C>>, ForwardedProps extends keyof React.ComponentProps<C> & string = keyof React.ComponentProps<C> & string>(component: C, options: FilteringStyledOptions<React.ComponentProps<C>, ForwardedProps>): CreateStyledComponent<Pick<PropsOf<C>, ForwardedProps> & {
-        theme?: ThemeContextProps;
-    }, {}, {
-        ref?: React.Ref<InstanceType<C>>;
-    }>;
-    <C extends React.ComponentClass<React.ComponentProps<C>>>(component: C, options?: StyledOptions<React.ComponentProps<C>>): CreateStyledComponent<PropsOf<C> & {
-        theme?: ThemeContextProps;
-    }, {}, {
-        ref?: React.Ref<InstanceType<C>>;
-    }>;
-    <C extends React.ComponentType<React.ComponentProps<C>>, ForwardedProps extends keyof React.ComponentProps<C> & string = keyof React.ComponentProps<C> & string>(component: C, options: FilteringStyledOptions<React.ComponentProps<C>, ForwardedProps>): CreateStyledComponent<Pick<PropsOf<C>, ForwardedProps> & {
-        theme?: ThemeContextProps;
-    }>;
-    <C extends React.ComponentType<React.ComponentProps<C>>>(component: C, options?: StyledOptions<React.ComponentProps<C>>): CreateStyledComponent<PropsOf<C> & {
-        theme?: ThemeContextProps;
-    }>;
-    <Tag extends keyof JSX.IntrinsicElements, ForwardedProps extends keyof JSX.IntrinsicElements[Tag] & string = keyof JSX.IntrinsicElements[Tag] & string>(tag: Tag, options: FilteringStyledOptions<JSX.IntrinsicElements[Tag], ForwardedProps>): CreateStyledComponent<{
-        theme?: ThemeContextProps;
-        as?: React.ElementType;
-    }, Pick<JSX.IntrinsicElements[Tag], ForwardedProps>>;
-    <Tag extends keyof JSX.IntrinsicElements>(tag: Tag, options?: StyledOptions<JSX.IntrinsicElements[Tag]>): CreateStyledComponent<{
-        theme?: ThemeContextProps;
-        as?: React.ElementType;
-    }, JSX.IntrinsicElements[Tag]>;
-}
-interface CreateStyled extends BaseCreateStyled, StyledTags {
-}
 declare const styled: CreateStyled;
 
-export { Accordion, AccordionProps, Button, ButtonProps, Dropdown, DropdownItem, DropdownProps, InputField, Modal, MultiSelect, MultiSelectProps, SingleSelect, SingleSelectProps, Slider, SliderProps, ThemeColors, ThemeColorsObject, ThemeContextProps, ThemeContextProvider, ThemeProperties, styled, transientOptions, useIsMobile, useThemeContext };
+/**
+ *
+ * @param color the color to get the contrast color for
+ * @returns the most readable color between black and white
+ */
+declare const getContrastColor: (color: string) => string;
+/**
+ *
+ * @param color the color to darken
+ * @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 strength the strength (0-100) to lighten the color
+ * @returns the color lightened by the strength
+ */
+declare const lightenColor: (color: string, strength?: number) => 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kwantis-id3/frontend-library",
-  "version": "0.27.2",
+  "version": "1.0.0-rc.4",
   "description": "Kwantis frontend components collection",
   "scriptsComments": {
     "storybook": "Starts storybook in development mode",
@@ -54,14 +54,14 @@
     "@storybook/react-webpack5": "7.4.6",
     "@storybook/testing-library": "0.2.2",
     "@testing-library/jest-dom": "^5.16.5",
-    "@testing-library/react": "^14.0.0",
-    "@testing-library/user-event": "^14.5.1",
+    "@testing-library/react": "^16.2.0",
+    "@testing-library/user-event": "^14.6.1",
     "@types/react": "^18.0.33",
     "@types/testing-library__jest-dom": "^5.14.5",
     "@types/tinycolor2": "^1.4.3",
     "@typescript-eslint/eslint-plugin": "^5.58.0",
     "@typescript-eslint/parser": "^5.58.0",
-    "@vitest/coverage-v8": "^1.1.0",
+    "@vitest/coverage-v8": "^3.0.5",
     "chromatic": "^11.0.4",
     "eslint": "^8.38.0",
     "eslint-config-prettier": "^8.8.0",
@@ -79,15 +79,17 @@
     "ts-node": "^10.9.1",
     "tslib": "^2.5.0",
     "typescript": "^5.0.3",
-    "vitest": "^1.1.0"
+    "vitest": "^3.0.5"
   },
   "peerDependencies": {
+    "@tanstack/react-table": "^8.0.0",
     "react": ">= 17.0.2"
   },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [
-    "dist"
+    "dist",
+    "src/types"
   ],
   "types": "dist/index.d.ts",
   "dependencies": {

package/src/types/emotion.d.ts

@@ -0,0 +1,8 @@
+import "@emotion/styled";
+import { IThemeContextValue } from "../components/ThemeContext/ThemeInterfaces";
+
+// override the default theme
+declare module "@emotion/react" {
+  // eslint-disable-next-line
+  export interface Theme extends IThemeContextValue {}
+}

package/src/types/tanstack.d.ts

@@ -0,0 +1,7 @@
+import "@tanstack/react-table";
+
+declare module "@tanstack/react-table" {
+  interface ColumnMeta<TData extends RowData, TValue> {
+    isHidden?: boolean;
+  }
+}