@carbon/ibm-products 2.43.2-canary.3 → 2.43.2-canary.300

package/es/components/ConditionBuilder/ConditionBuilder.d.ts

@@ -1,5 +1,12 @@
 /**
- * TODO: A description of the component.
+ * Copyright IBM Corp. 2024, 2024
+ *
+ * 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 let ConditionBuilder: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
 import React from 'react';
+import { ConditionBuilderProps } from './ConditionBuilder.types';
+/**
+ * TODO: A description of the component.
+ */
+export declare let ConditionBuilder: React.ForwardRefExoticComponent<ConditionBuilderProps & React.RefAttributes<HTMLDivElement>>;

package/es/components/ConditionBuilder/ConditionBuilder.js

@@ -8,16 +8,16 @@
 import { objectWithoutProperties as _objectWithoutProperties, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
 import React__default, { useRef } from 'react';
 import { VStack } from '@carbon/react';
-import PropTypes from '../../node_modules/prop-types/index.js';
+import PropTypes from '../../_virtual/index.js';
 import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import ConditionBuilderContent from './ConditionBuilderContent/ConditionBuilderContent.js';
 import { ConditionBuilderProvider } from './ConditionBuilderContext/ConditionBuilderProvider.js';
 import { pkg } from '../../settings.js';
-import { blockClass } from './ConditionBuilderContext/DataConfigs.js';
 import { handleKeyDown } from './utils/handleKeyboardEvents.js';
+import { blockClass, NON_HIERARCHICAL_VARIANT } from './utils/util.js';
 
-var _excluded = ["className", "inputConfig", "startConditionLabel", "popOverSearchThreshold", "getOptions", "initialState", "getConditionState", "variant"];
+var _excluded = ["className", "inputConfig", "startConditionLabel", "popOverSearchThreshold", "getOptions", "initialState", "getConditionState", "getActionsState", "variant", "actions", "translateWithId"];
 
 // Carbon and package components we use.
 /* TODO: @import(s) of carbon components and other package components. */
@@ -47,23 +47,30 @@ var componentName = 'ConditionBuilder';
 var ConditionBuilder = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     inputConfig = _ref.inputConfig,
-    startConditionLabel = _ref.startConditionLabel,
+    _ref$startConditionLa = _ref.startConditionLabel,
+    startConditionLabel = _ref$startConditionLa === void 0 ? 'Add Condition' : _ref$startConditionLa,
     popOverSearchThreshold = _ref.popOverSearchThreshold,
     getOptions = _ref.getOptions,
     initialState = _ref.initialState,
     getConditionState = _ref.getConditionState,
-    variant = _ref.variant,
+    getActionsState = _ref.getActionsState,
+    _ref$variant = _ref.variant,
+    variant = _ref$variant === void 0 ? NON_HIERARCHICAL_VARIANT : _ref$variant,
+    actions = _ref.actions,
+    translateWithId = _ref.translateWithId,
     rest = _objectWithoutProperties(_ref, _excluded);
-  var localRef = useRef();
+  var localRef = useRef(null);
   var conditionBuilderRef = ref || localRef;
   var handleKeyDownHandler = function handleKeyDownHandler(evt) {
-    handleKeyDown(evt, conditionBuilderRef);
+    handleKeyDown(evt, conditionBuilderRef, variant);
   };
   return /*#__PURE__*/React__default.createElement(ConditionBuilderProvider, {
     inputConfig: inputConfig,
     popOverSearchThreshold: popOverSearchThreshold,
     getOptions: getOptions,
-    variant: variant
+    variant: variant,
+    translateWithId: translateWithId,
+    conditionBuilderRef: conditionBuilderRef
   }, /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
     className: cx(blockClass,
     // Apply the block class to the main HTML element
@@ -74,16 +81,16 @@ var ConditionBuilder = /*#__PURE__*/React__default.forwardRef(function (_ref, re
       // switched classes dependant on props or state
       // example: [`${blockClass}__here-if-small`]: size === 'sm',
     }),
-    role: "main",
     ref: conditionBuilderRef
   }, getDevtoolsProps(componentName)), /*#__PURE__*/React__default.createElement(VStack, {
     className: "".concat(blockClass, "__").concat(variant),
     onKeyDown: handleKeyDownHandler
   }, /*#__PURE__*/React__default.createElement(ConditionBuilderContent, {
     startConditionLabel: startConditionLabel,
-    conditionBuilderRef: conditionBuilderRef,
     getConditionState: getConditionState,
-    initialState: initialState
+    getActionsState: getActionsState,
+    initialState: initialState,
+    actions: actions
   }))));
 });
 
@@ -99,45 +106,95 @@ ConditionBuilder.displayName = componentName;
 // See https://www.npmjs.com/package/prop-types#usage.
 ConditionBuilder.propTypes = {
   /**
-   * Provide the contents of the ConditionBuilder.
+   * optional array of actions
    */
-  //children: PropTypes.node.isRequired,
-
+  /**@ts-ignore */
+  actions: PropTypes.arrayOf(PropTypes.shape({
+    id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
+    label: PropTypes.string.isRequired
+  })),
   /**
    * Provide an optional class to be applied to the containing node.
    */
   className: PropTypes.string,
+  /**
+   * This is a callback that gives back the updated action state
+   */
+  getActionsState: PropTypes.func,
+  /**
+   * This is a callback that gives back updated condition state
+   */
   getConditionState: PropTypes.func.isRequired,
+  /**
+   * This is a callback that get triggered when  you want to dynamically fetch options.
+   *  Component call this when the option array is not passed against a property with type as option in the input config.
+   * This is an asynchronous callback that can return a promise , and you need to resolve the promise with options array in the valid format.
+   * You will receive the root condition state and current condition as the 2 arguments.
+   * eg: const getOptions = async (conditionState,condition) => {
+  switch (condition.property) {
+    case 'continent':
+      return new Promise((resolve) => {
+        const continents=[{
+      label: 'Africa',
+      id: 'Africa',
+    },...]
+          resolve(continents);
+      });
+      default:
+      return [];
+  }
+  };
+   */
   getOptions: PropTypes.func,
+  /**
+   * Optional prop if you want to pass a saved condition state, pass as "initialState.state".
+   * "initialState.enabledDefault" will populate the builder with the provided initial state before clicking Add Condition button.
+   *
+   *  This state should respect the structure of condition state that is available in getConditionState callback
+   */
+  /**@ts-ignore */
   initialState: PropTypes.shape({
-    groups: PropTypes.arrayOf(PropTypes.shape({
-      groupSeparateOperator: PropTypes.string,
-      groupOperator: PropTypes.string,
-      statement: PropTypes.string,
-      conditions: PropTypes.arrayOf(PropTypes.shape({
-        property: PropTypes.string,
-        operator: PropTypes.string,
-        value: PropTypes.string
-      }))
-    }))
+    state: PropTypes.shape({
+      groups: PropTypes.arrayOf(PropTypes.shape({
+        groupOperator: PropTypes.string,
+        statement: PropTypes.string,
+        conditions: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.shape({
+          property: PropTypes.string,
+          operator: PropTypes.string,
+          value: PropTypes.oneOfType([PropTypes.string, PropTypes.arrayOf(PropTypes.shape({
+            id: PropTypes.string,
+            label: PropTypes.string
+          })), PropTypes.shape({
+            id: PropTypes.string,
+            label: PropTypes.string
+          })])
+        }), PropTypes.object]))
+      })),
+      operator: PropTypes.string
+    }),
+    enabledDefault: PropTypes.bool
   }),
   /**
    * This is a mandatory prop that defines the input to the condition builder.
-   
-   */
+    */
+  /**@ts-ignore */
   inputConfig: PropTypes.shape({
     properties: PropTypes.arrayOf(PropTypes.shape({
-      id: PropTypes.string,
-      label: PropTypes.string,
+      id: PropTypes.string.isRequired,
+      label: PropTypes.string.isRequired,
       icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
-      type: PropTypes.oneOf(['text', 'number', 'date', 'option', 'time']),
+      type: PropTypes.oneOf(['text', 'textarea', 'number', 'date', 'option', 'time', 'custom']).isRequired,
       config: PropTypes.shape({
         options: PropTypes.arrayOf(PropTypes.shape({
-          id: PropTypes.string,
-          label: PropTypes.string,
+          id: PropTypes.string.isRequired,
+          label: PropTypes.string.isRequired,
           icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object])
         })),
-        includeSearch: PropTypes.bool
+        component: PropTypes.func,
+        operators: PropTypes.arrayOf(PropTypes.shape({
+          id: PropTypes.string.isRequired,
+          label: PropTypes.string.isRequired
+        }))
       })
     }))
   }).isRequired,
@@ -148,12 +205,20 @@ ConditionBuilder.propTypes = {
   /**
    * Provide a label to the button that starts condition builder
    */
-  startConditionLabel: PropTypes.string.isRequired,
+  startConditionLabel: PropTypes.string,
+  /**
+   * Optional prop, if you need to pass translations to the texts on the component instead of the defined defaults.
+   * This callback function will receive the message id and you need to return the corresponding text for that id.
+   * The message id will be one of [   "ifText","addConditionText",   "addConditionGroupText",   "addSubgroupText",   "conditionText",   "propertyText",   "operatorText",   "valueText",   "connectorText",   "conditionRowText","conditionRowGroupText","conditionBuilderText","actionSectionText",   "removeConditionText",   "addConditionRowText",   "startText",   "endText",   "clearSearchText",   "actionsText",   "then",   "removeActionText",   "addActionText",   "invalidText",  "invalidNumberWarnText"]
+  ]
+   */
+  /**@ts-ignore */
+  translateWithId: PropTypes.func,
   /* TODO: add types and DocGen for all props. */
   /**
-   * Provide the condition builder variant: sentence/ tree
+   * Provide the condition builder variant: Non-Hierarchical/ Hierarchical
    */
-  variant: PropTypes.string.isRequired
+  variant: PropTypes.oneOf(['Non-Hierarchical', 'Hierarchical'])
 };
 
 export { ConditionBuilder };

package/es/components/ConditionBuilder/ConditionBuilder.types.d.ts

@@ -0,0 +1,155 @@
+/// <reference path="../../../src/custom-typings/index.d.ts" />
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * 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 { TextAreaProps, TextInputProps } from '@carbon/react';
+import { CarbonIconType } from '@carbon/react/icons';
+import { NumberInputProps } from '@carbon/react/lib/components/NumberInput/NumberInput';
+import { Dispatch, ForwardedRef, PropsWithChildren, ReactNode, SetStateAction } from 'react';
+export type LogicalOperator = 'and' | 'or';
+export type StatementOperator = 'ifAll' | 'ifAny' | 'unlessAll' | 'unlessAny';
+type CoreOperator = 'is';
+type NumberOperator = 'greater' | 'greaterEqual' | 'lower' | 'lowerEqual';
+type StringOperator = 'startsWith' | 'endsWith';
+type ArrayOperator = 'contains';
+type OptionOperator = 'oneOf';
+type DateOperator = 'before' | 'after';
+export type Operator = LogicalOperator | StatementOperator | CoreOperator | NumberOperator | StringOperator | ArrayOperator | OptionOperator | DateOperator;
+export type OperatorGroups = 'logical' | 'statement' | 'core' | 'number' | 'string' | 'array' | 'option' | 'date';
+export type Operators = {
+    logical: LogicalOperator;
+    statement: StatementOperator;
+    core: CoreOperator;
+    number: NumberOperator;
+    string: StringOperator;
+    array: ArrayOperator;
+    option: OptionOperator;
+    date: DateOperator;
+};
+export type PropertyConfigOption = {
+    type: 'option';
+    config?: {
+        options?: {
+            id: string;
+            label: string;
+            icon?: CarbonIconType;
+        }[];
+    };
+};
+export interface PropertyConfigText {
+    type: 'text';
+    config: TextInputProps;
+}
+export interface PropertyConfigTextArea {
+    type: 'textarea';
+    config: TextAreaProps;
+}
+export interface PropertyConfigNumber {
+    type: 'number';
+    config: {
+        min?: number;
+        max?: number;
+        step?: number;
+        unit?: string;
+    } & NumberInputProps;
+}
+export type PropertyConfigDate = {
+    type: 'date';
+    config: object;
+};
+export type PropertyConfigTime = {
+    type: 'time';
+    config: {
+        timeZones: string[];
+    };
+};
+export type PropertyConfigCustom = {
+    type: 'custom';
+    config: {
+        component: React.ComponentType<any>;
+        operators: {
+            label: string;
+            id: string;
+        }[];
+    };
+};
+export type PropertyConfig = {
+    option: PropertyConfigOption;
+    text: PropertyConfigText;
+    textarea: PropertyConfigTextArea;
+    number: PropertyConfigNumber;
+    date: PropertyConfigDate;
+    time: PropertyConfigTime;
+    custom: PropertyConfigCustom;
+};
+export type Property = {
+    id: string;
+    label: string;
+    icon?: CarbonIconType;
+} & (PropertyConfig['option'] | PropertyConfig['text'] | PropertyConfig['number'] | PropertyConfig['date'] | PropertyConfig['textarea'] | PropertyConfig['time'] | PropertyConfig['custom']);
+export type inputConfig = {
+    properties: Property[];
+};
+export type Option = {
+    id: string;
+    label: string;
+    icon?: CarbonIconType;
+};
+export type Condition = {
+    property?: string;
+    operator?: Operator | '' | 'INVALID';
+    value?: string | Option[] | Option;
+    id?: string | number;
+    popoverToOpen?: string;
+};
+export type ConditionGroup = {
+    conditions?: (ConditionGroup | Condition)[];
+    groupOperator?: LogicalOperator;
+    statement?: StatementOperator;
+    id: string;
+};
+export type ConditionBuilderState = {
+    groups?: ConditionGroup[];
+    operator?: LogicalOperator;
+};
+export type Action = {
+    id?: string | number;
+    label?: string;
+};
+export type variantsType = 'Non-Hierarchical' | 'Hierarchical';
+export type ConditionBuilderProps = {
+    inputConfig: inputConfig;
+    initialState?: InitialState;
+    getActionsState?: (state: Action[] | undefined) => void;
+    getConditionState: (state: ConditionBuilderState | undefined) => void;
+    getOptions?: (state: ConditionBuilderState, condition: Condition) => Promise<Option[]>;
+    actions?: Action[];
+    className?: string;
+    popOverSearchThreshold: number;
+    startConditionLabel?: string;
+    variant?: 'Non-Hierarchical' | 'Hierarchical';
+    translateWithId: (id: string) => string;
+};
+export type InitialState = {
+    state: ConditionBuilderState;
+    enabledDefault?: boolean;
+};
+export interface ConditionBuilderContextInputProps extends PropsWithChildren {
+    children?: ReactNode;
+    inputConfig?: inputConfig;
+    popOverSearchThreshold?: number;
+    getOptions?: (state: ConditionBuilderState, condition: Condition) => Promise<Option[]>;
+    variant?: string;
+    translateWithId?: (id: string) => string;
+    conditionBuilderRef?: ForwardedRef<HTMLDivElement>;
+}
+export type ConditionBuilderContextProps = {
+    rootState?: ConditionBuilderState;
+    setRootState?: Dispatch<SetStateAction<ConditionBuilderState>>;
+    actionState?: Action[];
+    setActionState?: Dispatch<SetStateAction<Action[]>>;
+} & ConditionBuilderContextInputProps;
+export {};

package/es/components/ConditionBuilder/ConditionBuilderActions/ConditionBuilderActions.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * 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 { Action, Option } from '../ConditionBuilder.types';
+interface ConditionBuilderActionsProps {
+    actions: Action[] | Option[];
+    className?: string;
+}
+declare const ConditionBuilderActions: {
+    ({ actions, className, }: ConditionBuilderActionsProps): import("react/jsx-runtime").JSX.Element;
+    propTypes: {
+        /**
+         * optional array of object that give the list of actions.
+         */
+        actions: PropTypes.Requireable<(PropTypes.InferProps<{
+            id: PropTypes.Validator<NonNullable<NonNullable<string | number | null | undefined>>>;
+            label: PropTypes.Validator<string>;
+        }> | null | undefined)[]>;
+        /**
+         * Provide an optional class to be applied to the containing node.
+         */
+        className: PropTypes.Requireable<string>;
+    };
+};
+export default ConditionBuilderActions;

package/es/components/ConditionBuilder/ConditionBuilderActions/ConditionBuilderActions.js

@@ -0,0 +1,154 @@
+/**
+ * Copyright IBM Corp. 2020, 2024
+ *
+ * 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 { slicedToArray as _slicedToArray, defineProperty as _defineProperty, toConsumableArray as _toConsumableArray, objectSpread2 as _objectSpread2 } from '../../../_virtual/_rollupPluginBabelHelpers.js';
+import React__default, { useContext, useState } from 'react';
+import PropTypes from '../../../_virtual/index.js';
+import cx from 'classnames';
+import { Close } from '@carbon/react/icons';
+import { Section, Heading } from '@carbon/react';
+import { ConditionBuilderItem } from '../ConditionBuilderItem/ConditionBuilderItem.js';
+import { ConditionBuilderContext } from '../ConditionBuilderContext/ConditionBuilderProvider.js';
+import ConditionBuilderAdd from '../ConditionBuilderAdd/ConditionBuilderAdd.js';
+import uuidv4 from '../../../global/js/utils/uuidv4.js';
+import { ConditionBuilderButton } from '../ConditionBuilderButton/ConditionBuilderButton.js';
+import { useTranslations } from '../utils/useTranslations.js';
+import { ItemOptionForValueField } from '../ConditionBuilderItem/ConditionBuilderItemOption/ItemOptionForValueField.js';
+import { blockClass } from '../utils/util.js';
+
+var ConditionBuilderActions = function ConditionBuilderActions(_ref) {
+  var actions = _ref.actions,
+    className = _ref.className;
+  var _useContext = useContext(ConditionBuilderContext),
+    _useContext$actionSta = _useContext.actionState,
+    actionState = _useContext$actionSta === void 0 ? [] : _useContext$actionSta,
+    setActionState = _useContext.setActionState;
+  var _useState = useState(-1),
+    _useState2 = _slicedToArray(_useState, 2),
+    showDeletionPreview = _useState2[0],
+    setShowDeletionPreview = _useState2[1];
+  var _useTranslations = useTranslations(['actionsText', 'then', 'and', 'removeActionText', 'addActionText', 'actionSectionText']),
+    _useTranslations2 = _slicedToArray(_useTranslations, 6),
+    actionsText = _useTranslations2[0],
+    thenText = _useTranslations2[1],
+    andText = _useTranslations2[2],
+    removeActionText = _useTranslations2[3],
+    addActionText = _useTranslations2[4],
+    actionSectionText = _useTranslations2[5];
+  var addActionHandler = function addActionHandler() {
+    var action = {
+      id: uuidv4(),
+      label: undefined,
+      popoverToOpen: 'valueField'
+    };
+    setActionState === null || setActionState === void 0 || setActionState([].concat(_toConsumableArray(actionState), [action]));
+  };
+  var onchangeHandler = function onchangeHandler(selectedId, actionIndex) {
+    var action = actions.find(function (action) {
+      return action.id === selectedId;
+    }); //fetch the selected action from the input action array
+
+    // same actions can be added multiple times
+    var newAction = _objectSpread2(_objectSpread2({}, action), {}, {
+      id: actionState[actionIndex].id
+    });
+    setActionState === null || setActionState === void 0 || setActionState([].concat(_toConsumableArray(actionState.slice(0, actionIndex)), [newAction], _toConsumableArray(actionState.slice(actionIndex + 1))));
+  };
+  var onRemove = function onRemove(selectedId) {
+    setActionState === null || setActionState === void 0 || setActionState(actionState.filter(function (action) {
+      return action.id !== selectedId;
+    }));
+  };
+  var handleShowDeletionPreview = function handleShowDeletionPreview(index) {
+    setShowDeletionPreview(index);
+  };
+  var handleHideDeletionPreview = function handleHideDeletionPreview() {
+    setShowDeletionPreview(-1);
+  };
+  return /*#__PURE__*/React__default.createElement("div", {
+    className: className
+  }, /*#__PURE__*/React__default.createElement(Section, {
+    className: "".concat(blockClass, "__heading"),
+    level: 4
+  }, /*#__PURE__*/React__default.createElement(Heading, null, actionsText)), /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(blockClass, "__condition-wrapper"),
+    role: "grid",
+    "aria-label": actionSectionText
+  }, actionState === null || actionState === void 0 ? void 0 : actionState.map(function (action, index) {
+    return /*#__PURE__*/React__default.createElement("div", {
+      key: action.id,
+      role: "row",
+      className: cx("".concat(blockClass, "__condition-block ").concat(blockClass, "__gap ").concat(blockClass, "__gap-bottom"), _defineProperty({}, "".concat(blockClass, "__condition__deletion-preview"), showDeletionPreview == index))
+    }, /*#__PURE__*/React__default.createElement(ConditionBuilderItem, {
+      className: "".concat(blockClass, "__statement-button"),
+      tabIndex: 0,
+      popOverClassName: "".concat(blockClass, "__gap"),
+      label: index === 0 ? thenText : andText
+    }), /*#__PURE__*/React__default.createElement(ConditionBuilderItem, {
+      label: action.label,
+      title: actionsText,
+      condition: action,
+      "data-name": "valueField",
+      type: "option"
+    }, /*#__PURE__*/React__default.createElement(ItemOptionForValueField, {
+      conditionState: {
+        value: action.label
+      },
+      onChange: function onChange(selection) {
+        return onchangeHandler(selection.id, index);
+      },
+      config: {
+        options: actions
+      }
+    })), /*#__PURE__*/React__default.createElement("span", {
+      role: "gridcell",
+      "aria-label": removeActionText
+    }, /*#__PURE__*/React__default.createElement(ConditionBuilderButton, {
+      hideLabel: true,
+      label: removeActionText,
+      onClick: function onClick() {
+        return onRemove(action.id);
+      },
+      onMouseEnter: function onMouseEnter() {
+        return handleShowDeletionPreview(index);
+      },
+      onMouseLeave: handleHideDeletionPreview,
+      onFocus: function onFocus() {
+        return handleShowDeletionPreview(index);
+      },
+      onBlur: handleHideDeletionPreview,
+      renderIcon: Close,
+      className: "".concat(blockClass, "__close-condition"),
+      "data-name": "closeCondition"
+    })), actionState.length === index + 1 && /*#__PURE__*/React__default.createElement(ConditionBuilderAdd, {
+      onClick: addActionHandler,
+      className: "".concat(blockClass, "__gap ").concat(blockClass, "__gap-left"),
+      buttonLabel: addActionText,
+      tabIndex: 0
+    }));
+  }), actionState.length === 0 && /*#__PURE__*/React__default.createElement(ConditionBuilderAdd, {
+    onClick: addActionHandler,
+    className: "".concat(blockClass, "__gap ").concat(blockClass, "__gap-left"),
+    buttonLabel: addActionText,
+    tabIndex: 0
+  })));
+};
+ConditionBuilderActions.propTypes = {
+  /**
+   * optional array of object that give the list of actions.
+   */
+  actions: PropTypes.arrayOf(PropTypes.shape({
+    id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
+    label: PropTypes.string.isRequired
+  })),
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string
+};
+
+export { ConditionBuilderActions as default };

package/es/components/ConditionBuilder/ConditionBuilderAdd/ConditionBuilderAdd.d.ts

@@ -1,26 +1,63 @@
-export default ConditionBuilderAdd;
-declare function ConditionBuilderAdd({ className, onClick, addConditionSubGroupHandler, showConditionSubGroupPreviewHandler, hideConditionSubGroupPreviewHandler, showConditionPreviewHandler, hideConditionPreviewHandler, enableSubGroup, buttonLabel, }: {
-    className: any;
-    onClick: any;
-    addConditionSubGroupHandler: any;
-    showConditionSubGroupPreviewHandler: any;
-    hideConditionSubGroupPreviewHandler: any;
-    showConditionPreviewHandler: any;
-    hideConditionPreviewHandler: any;
-    enableSubGroup: any;
-    buttonLabel: any;
-}): import("react/jsx-runtime").JSX.Element;
-declare namespace ConditionBuilderAdd {
-    namespace propTypes {
-        let addConditionSubGroupHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let buttonLabel: PropTypes.Requireable<string>;
-        let className: PropTypes.Requireable<string>;
-        let enableSubGroup: PropTypes.Requireable<boolean>;
-        let hideConditionPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let hideConditionSubGroupPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let onClick: PropTypes.Requireable<(...args: any[]) => any>;
-        let showConditionPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let showConditionSubGroupPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
-    }
-}
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * 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';
+interface ConditionBuilderAddProps {
+    className?: string;
+    onClick: () => void;
+    addConditionSubGroupHandler?: () => void;
+    showConditionSubGroupPreviewHandler?: () => void;
+    hideConditionSubGroupPreviewHandler?: () => void;
+    showConditionPreviewHandler?: () => void;
+    hideConditionPreviewHandler?: () => void;
+    enableSubGroup?: boolean;
+    buttonLabel?: string;
+    tabIndex?: number;
+}
+declare const ConditionBuilderAdd: {
+    ({ className, onClick, addConditionSubGroupHandler, showConditionSubGroupPreviewHandler, hideConditionSubGroupPreviewHandler, showConditionPreviewHandler, hideConditionPreviewHandler, enableSubGroup, buttonLabel, tabIndex, }: ConditionBuilderAddProps): import("react/jsx-runtime").JSX.Element;
+    propTypes: {
+        /**
+         * handler for hiding sub group preview
+         */
+        addConditionSubGroupHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * handler for hiding sub group preview
+         */ /**
+        * tooltip label for plus button
+        */
+        buttonLabel: PropTypes.Requireable<string>;
+        /**
+         * Provide an optional class to be applied to the containing node.
+         */
+        className: PropTypes.Requireable<string>;
+        /**
+         * boolean to enable sub groups for the tree variant
+         */
+        enableSubGroup: PropTypes.Requireable<boolean>;
+        /**
+         * handler for hiding sub group preview
+         */
+        hideConditionPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        hideConditionSubGroupPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * handler for hiding sub group preview
+         */ /**
+        * callback triggered on click of add button
+        */
+        onClick: PropTypes.Requireable<(...args: any[]) => any>;
+        showConditionPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        showConditionSubGroupPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * handler for hiding sub group preview
+         */
+        /**
+         * Tab index
+         */
+        tabIndex: PropTypes.Requireable<number>;
+    };
+};
+export default ConditionBuilderAdd;