@nulogy/components 13.5.1 → 14.0.0

package/dist/src/DescriptionList/lib/types.d.ts

@@ -0,0 +1,26 @@
+import React from "react";
+import { DefaultNDSThemeType } from "../../theme";
+import { Breakpoints } from "../../theme/theme.type";
+export type Density = "medium" | "compact" | "relaxed";
+export type Layout = "stacked" | "inline" | "auto";
+export type Columns = number | Partial<Record<keyof Breakpoints, number>>;
+export type GroupMinWidth = string;
+export interface BaseDescriptionListProps {
+    descriptionTermMaxWidth?: string;
+    layout?: Layout;
+    autoLayoutBreakpoint?: string;
+    showDivider?: boolean;
+    density?: Density;
+    fontSize?: keyof DefaultNDSThemeType["fontSizes"];
+    lineHeight?: keyof DefaultNDSThemeType["lineHeights"];
+    children?: React.ReactNode;
+}
+export type DescriptionListWithColumns = BaseDescriptionListProps & {
+    columns?: Columns;
+    groupMinWidth?: never;
+};
+export type DescriptionListWithGroupMinWidth = BaseDescriptionListProps & {
+    groupMinWidth?: GroupMinWidth;
+    columns?: never;
+};
+export type DescriptionListProps = DescriptionListWithColumns | DescriptionListWithGroupMinWidth;

package/dist/src/DescriptionList/lib/utils.d.ts

@@ -0,0 +1,5 @@
+import { DescriptionListProps, Columns, GroupMinWidth } from "./types";
+export declare function validateAndExtractGridProps(props: DescriptionListProps): {
+    columns?: Columns;
+    groupMinWidth?: GroupMinWidth;
+};

package/dist/src/DescriptionList/stories/DescriptionList.column.story.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+import DescriptionList from "../DescriptionList";
+declare const _default: {
+    title: string;
+    component: typeof DescriptionList;
+};
+export default _default;
+export declare const TwoColumns: () => React.JSX.Element;
+export declare const ThreeColumns: () => React.JSX.Element;
+export declare const ResponsiveColumns: {
+    (): React.JSX.Element;
+    parameters: {
+        chromatic: {
+            viewports: number[];
+        };
+    };
+};

package/dist/src/DescriptionList/stories/DescriptionList.group-min-width.story.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+export declare const GroupMinWidth: {
+    (): React.JSX.Element;
+    parameters: {
+        chromatic: {
+            viewports: number[];
+        };
+    };
+};

package/dist/src/DescriptionList/stories/DescriptionList.layout.story.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+import DescriptionList from "../DescriptionList";
+declare const _default: {
+    title: string;
+    component: typeof DescriptionList;
+};
+export default _default;
+export declare const Inline: () => React.JSX.Element;
+export declare const Stacked: () => React.JSX.Element;
+export declare const Auto: {
+    (): React.JSX.Element;
+    parameters: {
+        chromatic: {
+            viewports: number[];
+        };
+    };
+};

package/dist/src/DescriptionList/stories/DescriptionList.playground.story.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+export declare const Playground: {
+    (): React.JSX.Element;
+    parameters: {
+        chromatic: {
+            disable: boolean;
+        };
+    };
+};

package/dist/src/DescriptionList/stories/DescriptionList.sizing.story.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import DescriptionList from "../DescriptionList";
+declare const _default: {
+    title: string;
+    component: typeof DescriptionList;
+};
+export default _default;
+export declare const Density: () => React.JSX.Element;
+export declare const FontSize: () => React.JSX.Element;
+export declare const LineHeight: () => React.JSX.Element;

package/dist/src/DescriptionList/stories/DescriptionList.spanning.story.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import DescriptionList from "../DescriptionList";
+declare const _default: {
+    title: string;
+    component: typeof DescriptionList;
+};
+export default _default;
+export declare const ColumnSpanning: () => React.JSX.Element;
+export declare const RowSpanning: () => React.JSX.Element;
+export declare const ColumnAndRowSpanning: () => React.JSX.Element;

package/dist/src/DescriptionList/stories/DescriptionList.story.d.ts

@@ -0,0 +1,8 @@
+import DescriptionList from "../DescriptionList";
+declare const _default: {
+    title: string;
+    component: typeof DescriptionList;
+};
+export default _default;
+export { GroupMinWidth } from "./DescriptionList.group-min-width.story";
+export { Playground } from "./DescriptionList.playground.story";

package/dist/src/DescriptionList/stories/fixtures.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+export declare const OutlinedDt: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>, never>, "ref"> & {
+    ref?: React.Ref<HTMLElement>;
+}, {
+    $outlined: boolean;
+    $highlighted?: boolean;
+}>> & string;
+export declare const OutlinedDd: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>, never>, "ref"> & {
+    ref?: React.Ref<HTMLElement>;
+}, {
+    $outlined: boolean;
+    $highlighted?: boolean;
+}>> & string;
+export declare const DashedBox: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<(Record<string, unknown> & {
+    children?: React.ReactNode;
+}) | (Omit<Record<string, unknown>, "ref"> & React.RefAttributes<React.Component<Record<string, unknown>, any, any>>), import("styled-components/dist/types").BaseObject>> & string & (Omit<React.ComponentClass<Record<string, unknown>, any>, keyof React.Component<any, {}, any>> | Omit<React.FunctionComponent<Record<string, unknown>>, keyof React.Component<any, {}, any>>);
+export declare const SampleContent: () => React.JSX.Element;

package/dist/src/DropdownMenu/DropdownText.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="react" />
 import type { TextProps } from "../Type";
-declare const DropdownText: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
+declare const DropdownText: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "compact" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
     variant?: import("../NDSProvider/ComponentVariantContext").ComponentVariant;
     inline?: boolean;
+    compact?: boolean;
     disabled?: boolean;
     textTransform?: "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "none" | "capitalize" | "full-size-kana" | "full-width" | "lowercase" | "uppercase";
     fontSize?: string;

package/dist/src/FieldLabel/HelpText.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="react" />
-declare const HelpText: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "disabled" | "textTransform" | keyof import("..").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
+declare const HelpText: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "compact" | "disabled" | "textTransform" | keyof import("..").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
     variant?: import("../NDSProvider/ComponentVariantContext").ComponentVariant;
     inline?: boolean;
+    compact?: boolean;
     disabled?: boolean;
     textTransform?: "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "none" | "capitalize" | "full-size-kana" | "full-width" | "lowercase" | "uppercase";
     fontSize?: string;

package/dist/src/Layout/Sidebar.d.ts

@@ -14,7 +14,7 @@ export type SidebarProps = Omit<AnimatedBoxProps, "width"> & {
     triggerRef?: RefObject<HTMLInputElement | HTMLButtonElement>;
     duration?: number;
     closeOnOutsideClick?: boolean;
-    overlay?: boolean;
+    overlay?: boolean | "show" | "hide" | "transparent";
     disableScroll?: boolean;
     hideCloseButton?: boolean;
     width?: SidebarWidth;

package/dist/src/TopBar/components/MenuItemLink.d.ts

@@ -1,10 +1,9 @@
 import { IconName } from "@nulogy/icons";
 import React, { ComponentProps } from "react";
 import { TileLink } from "../TopBar.styled";
-interface MenuItemLinkProps extends ComponentProps<typeof TileLink> {
+export interface MenuItemLinkProps extends ComponentProps<typeof TileLink> {
     title: string;
     description?: string;
     icon: IconName;
 }
 export declare function MenuItemLink({ description, title, icon, ...props }: MenuItemLinkProps): React.JSX.Element;
-export {};

package/dist/src/TopBar/index.d.ts

@@ -1 +1,2 @@
 export { TopBar } from "./TopBar";
+export type { MenuItemLinkProps } from "./components/MenuItemLink";

package/dist/src/Type/Headings.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="react" />
 import { TextProps } from "./Text";
-export declare const Heading1: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("styled-components").FastOmit<import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
+export declare const Heading1: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("styled-components").FastOmit<import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "compact" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
     variant?: import("../NDSProvider/ComponentVariantContext").ComponentVariant;
     inline?: boolean;
+    compact?: boolean;
     disabled?: boolean;
     textTransform?: "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "none" | "capitalize" | "full-size-kana" | "full-width" | "lowercase" | "uppercase";
     fontSize?: string;
@@ -11,9 +12,10 @@ export declare const Heading1: import("styled-components/dist/types").IStyledCom
 }, Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & {
     ref?: import("react").Ref<HTMLHeadingElement>;
 }>, never>, TextProps>> & string;
-export declare const Heading2: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("styled-components").FastOmit<import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
+export declare const Heading2: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("styled-components").FastOmit<import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "compact" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
     variant?: import("../NDSProvider/ComponentVariantContext").ComponentVariant;
     inline?: boolean;
+    compact?: boolean;
     disabled?: boolean;
     textTransform?: "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "none" | "capitalize" | "full-size-kana" | "full-width" | "lowercase" | "uppercase";
     fontSize?: string;
@@ -22,9 +24,10 @@ export declare const Heading2: import("styled-components/dist/types").IStyledCom
 }, Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & {
     ref?: import("react").Ref<HTMLHeadingElement>;
 }>, never>, never>> & string;
-export declare const Heading3: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("styled-components").FastOmit<import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
+export declare const Heading3: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("styled-components").FastOmit<import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "compact" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
     variant?: import("../NDSProvider/ComponentVariantContext").ComponentVariant;
     inline?: boolean;
+    compact?: boolean;
     disabled?: boolean;
     textTransform?: "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "none" | "capitalize" | "full-size-kana" | "full-width" | "lowercase" | "uppercase";
     fontSize?: string;
@@ -33,9 +36,10 @@ export declare const Heading3: import("styled-components/dist/types").IStyledCom
 }, Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & {
     ref?: import("react").Ref<HTMLHeadingElement>;
 }>, never>, never>> & string;
-export declare const Heading4: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("styled-components").FastOmit<import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
+export declare const Heading4: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("styled-components").FastOmit<import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("react").HTMLAttributes<HTMLParagraphElement> | "inline" | "compact" | "disabled" | "textTransform" | keyof import("../StyledProps").StyledProps> & import("react").HTMLAttributes<HTMLParagraphElement> & {
     variant?: import("../NDSProvider/ComponentVariantContext").ComponentVariant;
     inline?: boolean;
+    compact?: boolean;
     disabled?: boolean;
     textTransform?: "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "none" | "capitalize" | "full-size-kana" | "full-width" | "lowercase" | "uppercase";
     fontSize?: string;

package/dist/src/Type/Text.d.ts

@@ -4,6 +4,7 @@ import { StyledProps } from "../StyledProps";
 export type TextProps = React.HTMLAttributes<HTMLParagraphElement> & {
     variant?: ComponentVariant;
     inline?: boolean;
+    compact?: boolean;
     disabled?: boolean;
     textTransform?: "none" | "inherit" | "initial" | "-moz-initial" | "revert" | "unset" | "capitalize" | "full-size-kana" | "full-width" | "lowercase" | "uppercase" | undefined;
     fontSize?: string;

package/dist/src/index.d.ts

@@ -15,7 +15,8 @@ export { Card, CardSet } from "./Card";
 export { Checkbox, CheckboxGroup } from "./Checkbox";
 export { DatePicker, MonthPicker, WeekPicker } from "./DatePickers";
 export { DateRange } from "./DateRange";
-export { DescriptionDetails, DescriptionList, DescriptionTerm } from "./DescriptionList";
+export { DescriptionList, DescriptionDetails, DescriptionGroup, DescriptionTerm } from "./DescriptionList";
+export type { DescriptionListProps } from "./DescriptionList";
 export { Divider } from "./Divider";
 export { DropdownButton, DropdownItem, DropdownLink, DropdownMenu, DropdownText } from "./DropdownMenu";
 export { FieldLabel, HelpText, RequirementText } from "./FieldLabel";
@@ -56,6 +57,7 @@ export { toast, ToastContainer } from "./ToastContainer";
 export { Toggle } from "./Toggle";
 export { Tooltip } from "./Tooltip";
 export { TopBar } from "./TopBar";
+export type { MenuItemLinkProps } from "./TopBar";
 export { TruncatedText } from "./TruncatedText";
 export { Heading1, Heading2, Heading3, Heading4, Text } from "./Type";
 export type { TextProps } from "./Type";

package/dist/src/theme/theme.type.d.ts

@@ -104,7 +104,7 @@ interface Radii {
     medium: string;
     large: string;
     circle: string;
-    pill: string;
+    rounded: string;
 }
 export interface Breakpoints {
     extraSmall: string;

package/dist/src/utils/story/code.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+/**
+ * A styled component for displaying code in a storybook.
+ *
+ * @example
+ * <Code>const code = "console.log('Hello, world!');";</Code>
+ */
+export declare const Code: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLElement>, HTMLElement>, never>> & string;

package/dist/src/utils/story/resizable.d.ts

@@ -0,0 +1,18 @@
+import React from "react";
+interface ResizableProps {
+    children: React.ReactNode;
+    containerWidth?: string;
+    onResize?: (width: number) => void;
+    showContainerOutline?: boolean;
+}
+export declare const Resizable: ({ children, containerWidth, onResize, showContainerOutline, }: ResizableProps) => React.JSX.Element;
+export declare const WidthText: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<Omit<import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, "compact" | "inline" | "disabled" | "textTransform" | keyof React.HTMLAttributes<HTMLParagraphElement> | keyof import("../..").StyledProps> & React.HTMLAttributes<HTMLParagraphElement> & {
+    variant?: import("../../NDSProvider/ComponentVariantContext").ComponentVariant;
+    inline?: boolean;
+    compact?: boolean;
+    disabled?: boolean;
+    textTransform?: "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "none" | "full-width" | "capitalize" | "full-size-kana" | "lowercase" | "uppercase";
+    fontSize?: string;
+} & import("../..").StyledProps & import("framer-motion").MotionProps, "ref"> & React.RefAttributes<HTMLElement | SVGElement>, never>> & string & Omit<import("framer-motion").CustomDomComponent<import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, import("../../Type").TextProps>>, keyof React.Component<any, {}, any>>;
+export declare const ResizeHandle: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nulogy/components",
-  "version": "13.5.1",
+  "version": "14.0.0",
   "description": "Component library for the Nulogy Design System - http://nulogy.design",
   "private": false,
   "publishConfig": {
@@ -129,6 +129,7 @@
     "plop": "^2.4.0",
     "prettier": "^3.4.2",
     "react": "17.0.2",
+    "re-resizable": "^6.10.3",
     "react-color": "^2.18.1",
     "react-dom": "17.0.2",
     "react-router-dom": "^5.2.0",

package/dist/src/DescriptionList/DescriptionDetails.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="react" />
-export declare const DescriptionDetails: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLElement>, HTMLElement>, never>> & string;

package/dist/src/DescriptionList/DescriptionList.story.d.ts

@@ -1,14 +0,0 @@
-import React from "react";
-import { DescriptionList } from ".";
-declare const _default: {
-    title: string;
-    component: typeof DescriptionList;
-};
-export default _default;
-export declare function Layout(): React.JSX.Element;
-export declare function Density(): React.JSX.Element;
-export declare function FontSize(): React.JSX.Element;
-export declare function Divider(): React.JSX.Element;
-export declare function AutoLayoutCustomBreakpoint(): React.JSX.Element;
-export declare function CustomDescriptionTermWidth(): React.JSX.Element;
-export declare function CombinedFeatures(): React.JSX.Element;

package/dist/src/DescriptionList/DescriptionTerm.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="react" />
-export declare const DescriptionTerm: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLElement>, HTMLElement>, never>> & string;