carbon-react 117.4.1 → 117.6.0

package/lib/components/vertical-menu/vertical-menu-item.component.d.ts

@@ -5,6 +5,8 @@ import { IconType } from "../icon";
 export interface VerticalMenuItemProps<T = React.ElementType> extends PaddingProps, TagProps {
     /** Children of the menu item - another level of VerticalMenuItems */
     children?: React.ReactNode;
+    /** Default open state of the component */
+    defaultOpen?: boolean;
     /** Title of the menu item */
     title: string;
     /** Adornment of the menu item meant to be rendered on the right side */
@@ -21,5 +23,5 @@ export interface VerticalMenuItemProps<T = React.ElementType> extends PaddingPro
     component?: T;
 }
 declare type InferredComponentProps<T extends React.ElementType> = Omit<React.ComponentProps<T>, keyof VerticalMenuItemProps<T>>;
-export declare const VerticalMenuItem: <T>({ title, iconType, adornment, children, component, active, height, href, ...rest }: T extends React.ElementType<any> ? InferredComponentProps<T> & VerticalMenuItemProps<T> : VerticalMenuItemProps<React.ElementType<any>>) => JSX.Element;
+export declare const VerticalMenuItem: <T>({ defaultOpen, title, iconType, adornment, children, component, active, height, href, ...rest }: T extends React.ElementType<any> ? InferredComponentProps<T> & VerticalMenuItemProps<T> : VerticalMenuItemProps<React.ElementType<any>>) => JSX.Element;
 export default VerticalMenuItem;

package/lib/components/vertical-menu/vertical-menu-item.component.js

@@ -30,6 +30,7 @@ const MenuItemContext = /*#__PURE__*/_react.default.createContext({
 });
 
 const VerticalMenuItem = ({
+  defaultOpen = false,
   title,
   iconType,
   adornment,
@@ -40,7 +41,7 @@ const VerticalMenuItem = ({
   href,
   ...rest
 }) => {
-  const [isOpen, setIsOpen] = (0, _react.useState)(false);
+  const [isOpen, setIsOpen] = (0, _react.useState)(defaultOpen);
 
   const handleOnClick = () => {
     setIsOpen(state => !state);
@@ -124,6 +125,7 @@ VerticalMenuItem.propTypes = {
   "data-component": _propTypes.default.string,
   "data-element": _propTypes.default.string,
   "data-role": _propTypes.default.string,
+  "defaultOpen": _propTypes.default.bool,
   "height": _propTypes.default.string,
   "href": _propTypes.default.string,
   "iconType": _propTypes.default.oneOf(["add", "admin", "alert_on", "alert", "analysis", "arrow_bottom_right_circle", "arrow_down", "arrow_left_boxed", "arrow_left_right_small", "arrow_left_small", "arrow_left", "arrow_right_small", "arrow_right", "arrow_top_left_circle", "arrow_up", "arrow", "arrows_left_right", "attach", "bank_with_card", "bank", "basket_with_squares", "basket", "bed", "bin", "block_arrow_right", "blocked_square", "blocked", "bold", "box_arrow_left", "boxed_shapes", "bulk_destroy", "bullet_list_dotted", "bullet_list_numbers", "bullet_list", "business", "calendar_today", "calendar", "call", "camera", "car_lock", "car_money", "car_repair", "card_view", "caret_down", "caret_large_down", "caret_large_left", "caret_large_right", "caret_large_up", "caret_left", "caret_right", "caret_up", "cart", "cash", "chart_bar", "chart_line", "chart_pie", "chat_notes", "chat", "chevron_down_thick", "chevron_down", "chevron_left_thick", "chevron_left", "chevron_right_thick", "chevron_right", "chevron_up_thick", "chevron_up", "circle_with_dots", "circles_connection", "clock", "close", "coins", "collaborate", "computer_clock", "connect", "construction", "contacts", "copy", "create", "credit_card_slash", "credit_card", "cross_circle", "cross", "csv", "dashboard", "delete", "delivery", "disconnect", "disputed", "document_right_align", "document_tick", "document_vertical_lines", "download", "draft", "drag_vertical", "drag", "drill", "dropdown", "duplicate", "edit", "edited", "ellipsis_horizontal", "ellipsis_vertical", "email_switch", "email", "entry", "envelope_dollar", "envelope_euro", "error_square", "error", "euro", "expand", "factory", "favourite_lined", "favourite", "fax", "feedback", "file_excel", "file_generic", "file_image", "file_pdf", "file_word", "files_leaning", "filter_new", "filter", "fit_height", "fit_width", "flag", "folder", "form_refresh", "gift", "go", "graduation_hat", "graph", "grid", "hand_cash_coins", "hand_cash_note", "help", "hide", "home", "image", "in_progress", "in_transit", "individual", "info", "italic", "key", "laptop", "ledger_arrow_left", "ledger_arrow_right", "ledger", "lightbulb_off", "lightbulb_on", "link", "list_view", "location", "locked", "logout", "lookup", "marker", "message", "minus_large", "minus", "mobile", "money_bag", "none", "old_warning", "palm_tree", "pause_circle", "pause", "pdf", "people_switch", "people", "percentage_boxed", "person_info", "person_tick", "person", "petrol_pump", "phone", "piggy_bank", "plane", "play_circle", "play", "plus_large", "plus", "pound", "print", "progress", "progressed", "question_hollow", "question_mark", "question", "refresh_clock", "refresh", "remove", "sage_coin", "save", "scan", "search", "services", "settings_old", "settings", "share", "shop", "sort_down", "sort_up", "spanner", "split_container", "split", "square_dot", "squares_nine", "stacked_boxes", "stacked_squares", "submitted", "sync", "tag", "talk", "theatre_masks", "three_boxes", "tick_circle", "tick_thick", "tick", "true_tick", "u_turn_left", "u_turn_right", "undo", "unlocked", "upload", "uploaded", "video", "view", "warning"]),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "carbon-react",
-  "version": "117.4.1",
+  "version": "117.6.0",
   "description": "A library of reusable React components for easily building user interfaces.",
   "files": [
     "lib",
@@ -174,7 +174,7 @@
     "chalk": "^4.1.1",
     "ci-info": "^3.3.2",
     "classnames": "~2.2.6",
-    "crypto-js": "~3.3.0",
+    "crypto-js": "^4.1.1",
     "date-fns": "^2.26.0",
     "dotenv": "^10.0.0",
     "immutable": "~3.8.2",

package/esm/components/menu/menu-divider/menu-divider.d.ts

@@ -1,11 +0,0 @@
-import * as React from "react";
-
-export interface MenuDividerProps {
-  size?: "default" | "large";
-}
-
-declare function MenuDivider(
-  props: MenuDividerProps & React.RefAttributes<HTMLDivElement>
-): JSX.Element;
-
-export default MenuDivider;

package/esm/components/menu/menu-full-screen/menu-full-screen.d.ts

@@ -1,16 +0,0 @@
-import * as React from "react";
-
-export interface MenuFullscreenProps {
-  /** The child elements to render */
-  children?: React.ReactNode;
-  /** Sets whether the component is open or closed */
-  isOpen?: boolean;
-  /** The start position for the component to open from */
-  startPosition?: "left" | "right";
-  /** A callback to be called when the close icon is clicked or enter is pressed when focused */
-  onClose: React.MouseEventHandler<HTMLButtonElement>;
-}
-
-declare function MenuFullscreen(props: MenuFullscreenProps): JSX.Element;
-
-export default MenuFullscreen;

package/esm/components/menu/menu-item/menu-item.d.ts

@@ -1,60 +0,0 @@
-import * as React from "react";
-import { FlexboxProps, LayoutProps } from "styled-system";
-import { IconType } from "../../icon";
-
-export interface MenuItemBaseProps extends LayoutProps, FlexboxProps {
-  /** Custom className */
-  className?: string;
-  /** onClick handler */
-  onClick?: (event: React.MouseEvent<HTMLAnchorElement>) => void;
-  /** Defines which direction the submenu will hang eg. left/right */
-  submenuDirection?: string;
-  /** Is the menu item the currently selected item. */
-  selected?: boolean;
-  /** A title for the menu item that has a submenu. */
-  submenu?: React.ReactNode | boolean;
-  /** The href to use for the menu item. */
-  href?: string;
-  /** onKeyDown handler */
-  onKeyDown?: (event: React.KeyboardEvent<HTMLAnchorElement>) => void;
-  /** The target to use for the menu item. */
-  target?: string;
-  /** The rel attribute to be used for the underlying <a> tag */
-  rel?: string;
-  /** set the colour variant for a menuType */
-  variant?: "default" | "alternate";
-  /** Flag to display the dropdown arrow when an item has a submenu */
-  showDropdownArrow?: boolean;
-  /** If no text is provided an ariaLabel should be given to facilitate accessibility. */
-  ariaLabel?: string;
-  /** Callback triggered when submenu opens. Only valid with submenu prop */
-  onSubmenuOpen?: () => void;
-  /** Callback triggered when submenu closes. Only valid with submenu prop */
-  onSubmenuClose?: () => void;
-  /** 
-    @ignore @private
-    private prop, used inside ScrollableBlock to ensure the MenuItem's color variant overrides the CSS
-    for other MenuItems inside the block
-   */
-  overrideColor?: boolean;
-  /** @private @ignore */
-  "data-component"?: string;
-}
-
-export interface MenuWithChildren extends MenuItemBaseProps {
-  children: React.ReactNode;
-  /** Either prop `icon` must be defined or this node must have children. */
-  icon?: IconType;
-}
-
-export interface MenuWithIcon extends MenuItemBaseProps {
-  /** Either prop `icon` must be defined or this node must have children. */
-  icon: IconType;
-  children?: React.ReactNode;
-}
-
-export type MenuItemProps = MenuWithChildren | MenuWithIcon;
-
-declare function MenuItem(props: MenuItemProps): JSX.Element;
-
-export default MenuItem;

package/esm/components/menu/menu-segment-title/menu-segment-title.d.ts

@@ -1,12 +0,0 @@
-import * as React from "react";
-
-export interface MenuTitleProps {
-  children: string;
-  variant?: "default" | "alternate";
-}
-
-declare function MenuTitle(
-  props: MenuTitleProps & React.RefAttributes<HTMLDivElement>
-): JSX.Element;
-
-export default MenuTitle;

package/esm/components/menu/menu.d.ts

@@ -1,28 +0,0 @@
-import * as React from "react";
-import { LayoutProps, FlexboxProps } from "styled-system";
-
-type menuType = "light" | "dark" | "white" | "black";
-interface MenuContextProps {
-  menuType: menuType;
-  isFirstElement: boolean;
-  handleKeyDown: (
-    ev: React.KeyboardEvent<HTMLAnchorElement | HTMLButtonElement>,
-    submenuOpen?: boolean
-  ) => void;
-  isFocused: boolean;
-  openSubmenu: boolean;
-  inMenu: boolean;
-}
-
-export interface MenuProps extends LayoutProps, FlexboxProps {
-  /** Children elements */
-  children: React.ReactNode;
-  /** Defines the color scheme of the component */
-  menuType?: menuType;
-}
-
-declare const MenuContext: React.Context<MenuContextProps>;
-declare function Menu(props: MenuProps): JSX.Element;
-
-export { MenuContext };
-export default Menu;

package/esm/components/menu/scrollable-block/scrollable-block.d.ts

@@ -1,20 +0,0 @@
-import * as React from "react";
-
-export interface ScrollableBlockProps {
-  /** Children elements */
-  children: React.ReactNode;
-  /** A custom height to be applied to the component. */
-  height?: string | number;
-  /** set the colour variant for a menuType */
-  variant?: "default" | "alternate";
-  /** the element, if any, displayed at the top of the block to be its semantic "parent",
-   * but not part of the scrollable section
-   */
-  parent?: React.ReactElement;
-  /** the colour variant for the parent element, if different from the variant of the block */
-  parentVariant?: "default" | "alternate";
-}
-
-declare function ScrollableBlock(props: ScrollableBlockProps): JSX.Element;
-
-export default ScrollableBlock;

package/lib/components/menu/menu-divider/menu-divider.d.ts

@@ -1,11 +0,0 @@
-import * as React from "react";
-
-export interface MenuDividerProps {
-  size?: "default" | "large";
-}
-
-declare function MenuDivider(
-  props: MenuDividerProps & React.RefAttributes<HTMLDivElement>
-): JSX.Element;
-
-export default MenuDivider;

package/lib/components/menu/menu-full-screen/menu-full-screen.d.ts

@@ -1,16 +0,0 @@
-import * as React from "react";
-
-export interface MenuFullscreenProps {
-  /** The child elements to render */
-  children?: React.ReactNode;
-  /** Sets whether the component is open or closed */
-  isOpen?: boolean;
-  /** The start position for the component to open from */
-  startPosition?: "left" | "right";
-  /** A callback to be called when the close icon is clicked or enter is pressed when focused */
-  onClose: React.MouseEventHandler<HTMLButtonElement>;
-}
-
-declare function MenuFullscreen(props: MenuFullscreenProps): JSX.Element;
-
-export default MenuFullscreen;

package/lib/components/menu/menu-item/menu-item.d.ts

@@ -1,60 +0,0 @@
-import * as React from "react";
-import { FlexboxProps, LayoutProps } from "styled-system";
-import { IconType } from "../../icon";
-
-export interface MenuItemBaseProps extends LayoutProps, FlexboxProps {
-  /** Custom className */
-  className?: string;
-  /** onClick handler */
-  onClick?: (event: React.MouseEvent<HTMLAnchorElement>) => void;
-  /** Defines which direction the submenu will hang eg. left/right */
-  submenuDirection?: string;
-  /** Is the menu item the currently selected item. */
-  selected?: boolean;
-  /** A title for the menu item that has a submenu. */
-  submenu?: React.ReactNode | boolean;
-  /** The href to use for the menu item. */
-  href?: string;
-  /** onKeyDown handler */
-  onKeyDown?: (event: React.KeyboardEvent<HTMLAnchorElement>) => void;
-  /** The target to use for the menu item. */
-  target?: string;
-  /** The rel attribute to be used for the underlying <a> tag */
-  rel?: string;
-  /** set the colour variant for a menuType */
-  variant?: "default" | "alternate";
-  /** Flag to display the dropdown arrow when an item has a submenu */
-  showDropdownArrow?: boolean;
-  /** If no text is provided an ariaLabel should be given to facilitate accessibility. */
-  ariaLabel?: string;
-  /** Callback triggered when submenu opens. Only valid with submenu prop */
-  onSubmenuOpen?: () => void;
-  /** Callback triggered when submenu closes. Only valid with submenu prop */
-  onSubmenuClose?: () => void;
-  /** 
-    @ignore @private
-    private prop, used inside ScrollableBlock to ensure the MenuItem's color variant overrides the CSS
-    for other MenuItems inside the block
-   */
-  overrideColor?: boolean;
-  /** @private @ignore */
-  "data-component"?: string;
-}
-
-export interface MenuWithChildren extends MenuItemBaseProps {
-  children: React.ReactNode;
-  /** Either prop `icon` must be defined or this node must have children. */
-  icon?: IconType;
-}
-
-export interface MenuWithIcon extends MenuItemBaseProps {
-  /** Either prop `icon` must be defined or this node must have children. */
-  icon: IconType;
-  children?: React.ReactNode;
-}
-
-export type MenuItemProps = MenuWithChildren | MenuWithIcon;
-
-declare function MenuItem(props: MenuItemProps): JSX.Element;
-
-export default MenuItem;

package/lib/components/menu/menu-segment-title/menu-segment-title.d.ts

@@ -1,12 +0,0 @@
-import * as React from "react";
-
-export interface MenuTitleProps {
-  children: string;
-  variant?: "default" | "alternate";
-}
-
-declare function MenuTitle(
-  props: MenuTitleProps & React.RefAttributes<HTMLDivElement>
-): JSX.Element;
-
-export default MenuTitle;

package/lib/components/menu/menu.d.ts

@@ -1,28 +0,0 @@
-import * as React from "react";
-import { LayoutProps, FlexboxProps } from "styled-system";
-
-type menuType = "light" | "dark" | "white" | "black";
-interface MenuContextProps {
-  menuType: menuType;
-  isFirstElement: boolean;
-  handleKeyDown: (
-    ev: React.KeyboardEvent<HTMLAnchorElement | HTMLButtonElement>,
-    submenuOpen?: boolean
-  ) => void;
-  isFocused: boolean;
-  openSubmenu: boolean;
-  inMenu: boolean;
-}
-
-export interface MenuProps extends LayoutProps, FlexboxProps {
-  /** Children elements */
-  children: React.ReactNode;
-  /** Defines the color scheme of the component */
-  menuType?: menuType;
-}
-
-declare const MenuContext: React.Context<MenuContextProps>;
-declare function Menu(props: MenuProps): JSX.Element;
-
-export { MenuContext };
-export default Menu;

package/lib/components/menu/scrollable-block/scrollable-block.d.ts

@@ -1,20 +0,0 @@
-import * as React from "react";
-
-export interface ScrollableBlockProps {
-  /** Children elements */
-  children: React.ReactNode;
-  /** A custom height to be applied to the component. */
-  height?: string | number;
-  /** set the colour variant for a menuType */
-  variant?: "default" | "alternate";
-  /** the element, if any, displayed at the top of the block to be its semantic "parent",
-   * but not part of the scrollable section
-   */
-  parent?: React.ReactElement;
-  /** the colour variant for the parent element, if different from the variant of the block */
-  parentVariant?: "default" | "alternate";
-}
-
-declare function ScrollableBlock(props: ScrollableBlockProps): JSX.Element;
-
-export default ScrollableBlock;