@carbon/react 1.21.0 → 1.22.0-rc.0

package/es/components/UIShell/SideNavMenu.js

@@ -11,9 +11,9 @@ import cx from 'classnames';
 import PropTypes from 'prop-types';
 import React__default, { useState } from 'react';
 import SideNavIcon from './SideNavIcon.js';
-import { Escape } from '../../internal/keyboard/keys.js';
-import { match } from '../../internal/keyboard/match.js';
 import { usePrefix } from '../../internal/usePrefix.js';
+import { match } from '../../internal/keyboard/match.js';
+import { Escape } from '../../internal/keyboard/keys.js';
 
 var _ChevronDown;
 var SideNavMenu = /*#__PURE__*/React__default.forwardRef(function SideNavMenu(props, ref) {
@@ -158,4 +158,6 @@ function hasActiveChild(children) {
   return false;
 }
 
-export { SideNavMenu, SideNavMenu as default };
+var SideNavMenu$1 = SideNavMenu;
+
+export { SideNavMenu, SideNavMenu$1 as default };

package/es/components/UIShell/SideNavMenuItem.js

@@ -52,5 +52,6 @@ SideNavMenuItem.propTypes = {
    */
   isActive: PropTypes.bool
 };
+var SideNavMenuItem$1 = SideNavMenuItem;
 
-export { SideNavMenuItem as default };
+export { SideNavMenuItem$1 as default };

package/es/components/UIShell/SideNavSwitcher.js

@@ -77,5 +77,6 @@ SideNavSwitcher.propTypes = {
    */
   options: PropTypes.arrayOf(PropTypes.string).isRequired
 };
+var SideNavSwitcher$1 = SideNavSwitcher;
 
-export { SideNavSwitcher as default };
+export { SideNavSwitcher$1 as default };

package/es/components/UIShell/Switcher.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { objectSpread2 as _objectSpread2, defineProperty as _defineProperty, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { defineProperty as _defineProperty, extends as _extends, objectSpread2 as _objectSpread2 } from '../../_virtual/_rollupPluginBabelHelpers.js';
 import React__default from 'react';
 import cx from 'classnames';
 import PropTypes from 'prop-types';
@@ -40,5 +40,6 @@ Switcher.propTypes = _objectSpread2(_objectSpread2({}, AriaLabelPropType), {}, {
    */
   className: PropTypes.string
 });
+var Switcher$1 = Switcher;
 
-export { Switcher as default };
+export { Switcher$1 as default };

package/es/components/UIShell/SwitcherDivider.js

@@ -30,5 +30,6 @@ SwitcherDivider.propTypes = {
    */
   className: PropTypes.string
 };
+var SwitcherDivider$1 = SwitcherDivider;
 
-export { SwitcherDivider as default };
+export { SwitcherDivider$1 as default };

package/es/components/UIShell/SwitcherItem.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { objectSpread2 as _objectSpread2, objectWithoutProperties as _objectWithoutProperties, defineProperty as _defineProperty, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { objectWithoutProperties as _objectWithoutProperties, defineProperty as _defineProperty, extends as _extends, objectSpread2 as _objectSpread2 } from '../../_virtual/_rollupPluginBabelHelpers.js';
 import React__default from 'react';
 import cx from 'classnames';
 import PropTypes from 'prop-types';
@@ -57,5 +57,6 @@ SwitcherItem.propTypes = _objectSpread2(_objectSpread2({}, AriaLabelPropType), {
    */
   tabIndex: PropTypes.number
 });
+var SwitcherItem$1 = SwitcherItem;
 
-export { SwitcherItem as default };
+export { SwitcherItem$1 as default };

package/es/components/UnorderedList/UnorderedList.js

@@ -54,5 +54,6 @@ UnorderedList.defaultProps = {
   nested: false,
   isExpressive: false
 };
+var UnorderedList$1 = UnorderedList;
 
-export { UnorderedList as default };
+export { UnorderedList$1 as default };

package/es/es/components/DataTable/TableSelectAll.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Copyright IBM Corp. 2016, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import PropTypes from 'prop-types';
+import React from 'react';
+interface TableSelectAllProps {
+    /**
+     * Specify the aria label for the underlying input control
+     */
+    ariaLabel: string;
+    /**
+     * Specify whether all items are selected, or not
+     */
+    checked: boolean;
+    /**
+     * The CSS class names of the cell that wraps the underlying input control
+     */
+    className?: string;
+    /**
+     * Specify whether the checkbox input should be disabled
+     */
+    disabled?: boolean;
+    /**
+     * Provide an `id` for the underlying input control
+     */
+    id: string;
+    /**
+     * Specify whether the selection only has a subset of all items
+     */
+    indeterminate?: boolean;
+    /**
+     * Provide a `name` for the underlying input control
+     */
+    name: string;
+    /**
+     * Provide a handler to listen to when a user initiates a selection request
+     */
+    onSelect: React.MouseEventHandler<HTMLInputElement>;
+}
+declare const TableSelectAll: {
+    ({ ariaLabel, checked, id, indeterminate, name, onSelect, disabled, className, }: TableSelectAllProps): JSX.Element;
+    propTypes: {
+        /**
+         * Specify the aria label for the underlying input control
+         */
+        ariaLabel: PropTypes.Validator<string>;
+        /**
+         * Specify whether all items are selected, or not
+         */
+        checked: PropTypes.Validator<boolean>;
+        /**
+         * The CSS class names of the cell that wraps the underlying input control
+         */
+        className: PropTypes.Requireable<string>;
+        /**
+         * Specify whether the checkbox input should be disabled
+         */
+        disabled: PropTypes.Requireable<boolean>;
+        /**
+         * Provide an `id` for the underlying input control
+         */
+        id: PropTypes.Validator<string>;
+        /**
+         * Specify whether the selection only has a subset of all items
+         */
+        indeterminate: PropTypes.Requireable<boolean>;
+        /**
+         * Provide a `name` for the underlying input control
+         */
+        name: PropTypes.Validator<string>;
+        /**
+         * Provide a handler to listen to when a user initiates a selection request
+         */
+        onSelect: PropTypes.Validator<(...args: any[]) => any>;
+    };
+    defaultProps: {
+        ariaLabel: string;
+    };
+};
+export default TableSelectAll;

package/es/es/components/Dropdown/Dropdown.d.ts

@@ -0,0 +1,134 @@
+/**
+ * Copyright IBM Corp. 2022
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { ReactNode } from 'react';
+import { UseSelectProps } from 'downshift';
+import { ListBoxSize, ListBoxType } from '../ListBox';
+import { ReactAttr } from '../../types/common';
+type ExcludedAttributes = 'id' | 'onChange';
+export interface OnChangeData<ItemType> {
+    selectedItem: ItemType | null;
+}
+export interface DropdownProps<ItemType> extends Omit<ReactAttr<HTMLDivElement>, ExcludedAttributes> {
+    /**
+     * 'aria-label' of the ListBox component.
+     */
+    ariaLabel?: string;
+    /**
+     * Specify the direction of the dropdown. Can be either top or bottom.
+     */
+    direction?: 'top' | 'bottom';
+    /**
+     * Disable the control
+     */
+    disabled?: boolean;
+    /**
+     * Additional props passed to Downshift
+     */
+    downshiftProps?: Partial<UseSelectProps<ItemType>>;
+    /**
+     * Provide helper text that is used alongside the control label for
+     * additional help
+     */
+    helperText?: React.ReactNode;
+    /**
+     * Specify whether the title text should be hidden or not
+     */
+    hideLabel?: boolean;
+    /**
+     * Specify a custom `id`
+     */
+    id: string;
+    /**
+     * Allow users to pass in an arbitrary item or a string (in case their items are an array of strings)
+     * from their collection that are pre-selected
+     */
+    initialSelectedItem?: ItemType;
+    /**
+     * Specify if the currently selected value is invalid.
+     */
+    invalid?: boolean;
+    /**
+     * Message which is displayed if the value is invalid.
+     */
+    invalidText?: React.ReactNode;
+    /**
+     * Function to render items as custom components instead of strings.
+     * Defaults to null and is overridden by a getter
+     */
+    itemToElement?: React.JSXElementConstructor<ItemType> | null;
+    /**
+     * Helper function passed to downshift that allows the library to render a
+     * given item to a string label. By default, it extracts the `label` field
+     * from a given item to serve as the item label in the list.
+     */
+    itemToString?(item: ItemType): string;
+    /**
+     * We try to stay as generic as possible here to allow individuals to pass
+     * in a collection of whatever kind of data structure they prefer
+     */
+    items: ItemType[];
+    /**
+     * Generic `label` that will be used as the textual representation of what
+     * this field is for
+     */
+    label: NonNullable<ReactNode>;
+    /**
+     * `true` to use the light version.
+     * @deprecated The `light` prop for `Dropdown` has been deprecated
+     * in favor of the new `Layer` component. It will be removed in the next major release.
+     */
+    light?: boolean;
+    /**
+     * `onChange` is a utility for this controlled component to communicate to a
+     * consuming component what kind of internal state changes are occurring.
+     */
+    onChange?(data: OnChangeData<ItemType>): void;
+    /**
+     * Whether or not the Dropdown is readonly
+     */
+    readOnly?: boolean;
+    /**
+     * An optional callback to render the currently selected item as a react element instead of only
+     * as a string.
+     */
+    renderSelectedItem?(item: ItemType): string;
+    /**
+     * In the case you want to control the dropdown selection entirely.
+     */
+    selectedItem?: ItemType;
+    /**
+     * Specify the size of the ListBox. Currently supports either `sm`, `md` or `lg` as an option.
+     */
+    size?: ListBoxSize;
+    /**
+     * Provide the title text that will be read by a screen reader when
+     * visiting this control
+     */
+    titleText?: React.ReactNode;
+    /**
+     * Callback function for translating ListBoxMenuIcon SVG title
+     */
+    translateWithId?(messageId: string, args?: Record<string, unknown>): string;
+    /**
+     * The dropdown type, `default` or `inline`
+     */
+    type?: ListBoxType;
+    /**
+     * Specify whether the control is currently in warning state
+     */
+    warn?: boolean;
+    /**
+     * Provide the text that is displayed when the control is in warning state
+     */
+    warnText?: React.ReactNode;
+}
+type DropdownComponentProps<ItemType> = React.PropsWithoutRef<React.PropsWithChildren<DropdownProps<ItemType>> & React.RefAttributes<HTMLButtonElement>>;
+interface DropdownComponent {
+    <ItemType>(props: DropdownComponentProps<ItemType>): React.ReactElement | null;
+}
+declare const _default: DropdownComponent;
+export default _default;

package/es/es/components/Dropdown/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2016, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import Dropdown, { OnChangeData } from './Dropdown';
+export type { OnChangeData };
+export { Dropdown };
+export { default as DropdownSkeleton } from './Dropdown.Skeleton';
+export default Dropdown;

package/es/es/components/FluidForm/FluidForm.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import { ReactAttr } from '../../types/common';
+export type FluidFormProps = ReactAttr<HTMLFormElement>;
+declare const FluidForm: React.FC<FluidFormProps>;
+export default FluidForm;

package/es/es/components/FluidForm/FormContext.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/// <reference types="react" />
+export interface FormContextProps {
+    isFluid?: boolean;
+}
+export declare const FormContext: import("react").Context<FormContextProps>;

package/es/es/components/FluidForm/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import FluidForm from './FluidForm';
+export default FluidForm;
+export { FluidForm };
+export { FormContext } from './FormContext';

package/es/es/components/ListBox/ListBox.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import { ListBoxType, ListBoxSize } from './ListBoxPropTypes';
+import { ForwardRefReturn, ReactAttr } from '../../types/common';
+type ExcludedAttributes = 'onKeyDown' | 'onKeyPress' | 'ref';
+export interface ListBoxProps extends Omit<ReactAttr<HTMLDivElement>, ExcludedAttributes> {
+    /**
+     * Specify whether the ListBox is currently disabled
+     */
+    disabled?: boolean;
+    /**
+     * Specify whether the control is currently invalid
+     */
+    invalid?: boolean;
+    /**
+     * Specify the text to be displayed when the control is invalid
+     */
+    invalidText?: React.ReactNode;
+    /**
+     * Specify if the control should render open
+     */
+    isOpen?: boolean;
+    /**
+     * `true` to use the light version. For use on $ui-01 backgrounds only.
+     * Don't use this to make tile background color same as container background color.
+     *
+     * @deprecated The `light` prop for `ListBox` has been deprecated in favor of
+     * the new `Layer` component. It will be removed in the next major release.
+     */
+    light?: boolean;
+    /**
+     * Specify the size of the ListBox. Currently supports either `sm`, `md` or `lg` as an option.
+     */
+    size?: ListBoxSize;
+    /**
+     * Specify the "type" of the ListBox. Currently supports either `default` or
+     * `inline` as an option.
+     */
+    type?: ListBoxType;
+    /**
+     * Specify whether the control is currently in warning state
+     */
+    warn?: boolean;
+    /**
+     * Provide the text that is displayed when the control is in warning state
+     */
+    warnText?: React.ReactNode;
+}
+export type ListBoxComponent = ForwardRefReturn<HTMLDivElement, ListBoxProps>;
+/**
+ * `ListBox` is a generic container component that handles creating the
+ * container class name in response to certain props.
+ */
+declare const ListBox: ListBoxComponent;
+export default ListBox;

package/es/es/components/ListBox/ListBoxField.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import { ReactAttr } from '../../types/common';
+export declare const translationIds: {};
+export interface ListBoxFieldProps extends ReactAttr<HTMLDivElement> {
+    /**
+     * Specify if the parent <ListBox> is disabled
+     */
+    disabled?: boolean;
+}
+export type ListBoxFieldComponent = React.FC<ListBoxFieldProps>;
+declare const _default: ListBoxFieldComponent;
+export default _default;

package/es/es/components/ListBox/ListBoxMenu.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { ForwardRefReturn, ReactAttr } from '../../types/common';
+type ExcludedAttributes = 'id';
+export interface ListBoxMenuProps extends Omit<ReactAttr<HTMLDivElement>, ExcludedAttributes> {
+    /**
+     * Specify a custom `id`
+     */
+    id: string;
+}
+export type ListBoxMenuComponent = ForwardRefReturn<HTMLDivElement, ListBoxMenuProps>;
+/**
+ * `ListBoxMenu` is a simple container node that isolates the `list-box__menu`
+ * class into a single component. It is also being used to validate given
+ * `children` components.
+ */
+declare const ListBoxMenu: ListBoxMenuComponent;
+export default ListBoxMenu;

package/es/es/components/ListBox/ListBoxMenuIcon.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+export declare const translationIds: {
+    'close.menu': string;
+    'open.menu': string;
+};
+export interface ListBoxMenuIconProps {
+    /**
+     * Specify whether the menu is currently open, which will influence the
+     * direction of the menu icon
+     */
+    isOpen: boolean;
+    /**
+     * i18n hook used to provide the appropriate description for the given menu
+     * icon. This function takes in an id defined in `translationIds` and should
+     * return a string message for that given message id.
+     */
+    translateWithId?(messageId: string, args?: Record<string, unknown>): string;
+}
+export type ListBoxMenuIconComponent = React.FC<ListBoxMenuIconProps>;
+/**
+ * `ListBoxMenuIcon` is used to orient the icon up or down depending on the
+ * state of the menu for a given `ListBox`
+ */
+declare const ListBoxMenuIcon: ListBoxMenuIconComponent;
+export default ListBoxMenuIcon;

package/es/es/components/ListBox/ListBoxMenuItem.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { ForwardedRef } from 'react';
+import { ForwardRefReturn, ReactAttr } from '../../types/common';
+export interface ListBoxMenuItemProps extends ReactAttr<HTMLDivElement> {
+    /**
+     * Specify whether the current menu item is "active".
+     */
+    isActive?: boolean;
+    /**
+     * Specify whether the current menu item is "highlighted".
+     */
+    isHighlighted?: boolean;
+}
+export type ListBoxMenuItemForwardedRef = ForwardedRef<HTMLDivElement> & {
+    menuItemOptionRef?: React.Ref<HTMLDivElement>;
+} | null;
+export type ListBoxMenuItemComponent = ForwardRefReturn<ListBoxMenuItemForwardedRef, ListBoxMenuItemProps>;
+declare const _default: ListBoxMenuItemComponent;
+export default _default;

package/es/es/components/ListBox/ListBoxPropTypes.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import PropTypes from 'prop-types';
+declare const listBoxTypes: readonly ["default", "inline"];
+declare const listBoxSizes: readonly ["sm", "md", "lg"];
+export type ListBoxType = typeof listBoxTypes[number];
+export type ListBoxSize = typeof listBoxSizes[number];
+export declare const ListBoxType: PropTypes.Requireable<"default" | "inline">;
+export declare const ListBoxSize: PropTypes.Requireable<"md" | "sm" | "lg">;
+export {};

package/es/es/components/ListBox/ListBoxSelection.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import { KeyboardEvent, MouseEvent } from 'react';
+export interface ListBoxSelectionProps {
+    /**
+     * Specify a function to be invoked when a user interacts with the clear
+     * selection element.
+     */
+    clearSelection(event: MouseEvent<HTMLDivElement> | KeyboardEvent<HTMLDivElement>): void;
+    /**
+     * Specify whether or not the clear selection element should be disabled
+     */
+    disabled?: boolean;
+    /**
+     * Specify an optional `onClearSelection` handler that is called when the underlying
+     * element is cleared
+     */
+    onClearSelection?(event: MouseEvent<HTMLDivElement> | KeyboardEvent<HTMLDivElement>): void;
+    /**
+     * Whether or not the Dropdown is readonly
+     */
+    readOnly?: boolean;
+    /**
+     * Specify an optional `selectionCount` value that will be used to determine
+     * whether the selection should display a badge or a single clear icon.
+     */
+    selectionCount?: number;
+    /**
+     * i18n hook used to provide the appropriate description for the given menu
+     * icon. This function takes in an id defined in `translationIds` and should
+     * return a string message for that given message id.
+     */
+    translateWithId(messageId: string, args?: Record<string, unknown>): string;
+}
+export type ListBoxSelectionComponent = React.FC<ListBoxSelectionProps>;
+/**
+ * `ListBoxSelection` is used to provide controls for clearing a selection, in
+ * addition to conditionally rendering a badge if the control has more than one
+ * selection.
+ */
+declare const ListBoxSelection: ListBoxSelectionComponent;
+export declare const translationIds: {
+    'clear.all': string;
+    'clear.selection': string;
+};
+export default ListBoxSelection;

package/es/es/components/ListBox/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export * as PropTypes from './ListBoxPropTypes';
+export * from './ListBoxPropTypes';
+import { ListBoxComponent as ListBoxPartialComponent } from './ListBox';
+import { ListBoxFieldComponent } from './ListBoxField';
+import { ListBoxMenuComponent } from './ListBoxMenu';
+import { ListBoxMenuIconComponent } from './ListBoxMenuIcon';
+import { ListBoxMenuItemComponent } from './ListBoxMenuItem';
+import { ListBoxSelectionComponent } from './ListBoxSelection';
+export interface ListBoxComponent extends ListBoxPartialComponent {
+    readonly Field: ListBoxFieldComponent;
+    readonly Menu: ListBoxMenuComponent;
+    readonly MenuIcon: ListBoxMenuIconComponent;
+    readonly MenuItem: ListBoxMenuItemComponent;
+    readonly Selection: ListBoxSelectionComponent;
+}
+declare const ListBox: ListBoxComponent;
+export default ListBox;

package/es/es/components/NumberInput/NumberInput.Skeleton.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright IBM Corp. 2016, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import PropTypes from 'prop-types';
+import { HTMLAttributes } from 'react';
+export interface NumberInputSkeletonProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * Specify an optional className to add to the form item wrapper.
+     */
+    className?: string;
+    /**
+     * Specify whether the label should be hidden, or not
+     */
+    hideLabel?: boolean;
+}
+declare function NumberInputSkeleton({ hideLabel, className, ...rest }: NumberInputSkeletonProps): JSX.Element;
+declare namespace NumberInputSkeleton {
+    var propTypes: {
+        /**
+         * Specify an optional className to add to the form item wrapper.
+         */
+        className: PropTypes.Requireable<string>;
+        /**
+         * Specify whether the label should be hidden, or not
+         */
+        hideLabel: PropTypes.Requireable<boolean>;
+    };
+}
+export default NumberInputSkeleton;