@dxc-technology/halstack-react 0.0.0-290c489 → 0.0.0-293a019

package/accordion-group/AccordionGroup.test.js

@@ -6,40 +6,13 @@ var _react = _interopRequireDefault(require("react"));
 
 var _react2 = require("@testing-library/react");
 
-var _AccordionGroup = _interopRequireDefault(require("./AccordionGroup"));
+var _AccordionGroup = _interopRequireDefault(require("./AccordionGroup.tsx"));
 
 describe("Accordion component tests", function () {
-  test("Uncontrolled accordion group renders with children", function () {
-    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], null, /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"].Accordion, {
-      label: "Accordion1",
-      padding: "medium"
-    }, /*#__PURE__*/_react["default"].createElement("div", null, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo lobortis eget.")), /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"].Accordion, {
-      label: "Accordion2",
-      padding: "medium"
-    }, /*#__PURE__*/_react["default"].createElement("div", null, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo lobortis eget.")))),
-        getByText = _render.getByText,
-        getAllByRole = _render.getAllByRole;
-
-    expect(getByText("Accordion1")).toBeTruthy();
-    expect(getByText("Accordion2")).toBeTruthy();
-    expect(getAllByRole("button")[0].getAttribute("aria-expanded")).toBe("false");
-    expect(getAllByRole("button")[1].getAttribute("aria-expanded")).toBe("false");
-  });
-  test("Uncontrolled accordion group renders with only one children", function () {
-    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], null, /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"].Accordion, {
-      label: "Accordion1",
-      padding: "medium"
-    }, /*#__PURE__*/_react["default"].createElement("div", null, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo lobortis eget.")))),
-        getByText = _render2.getByText,
-        getAllByRole = _render2.getAllByRole;
-
-    expect(getByText("Accordion1")).toBeTruthy();
-    expect(getAllByRole("button")[0].getAttribute("aria-expanded")).toBe("false");
-  });
   test("Uncontrolled accordion group calls correct function on click", function () {
     var onActiveChange = jest.fn();
 
-    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], {
       margin: "large",
       onActiveChange: onActiveChange
     }, /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"].Accordion, {
@@ -50,8 +23,8 @@ describe("Accordion component tests", function () {
       label: "Accordion2",
       padding: "medium"
     }, /*#__PURE__*/_react["default"].createElement("div", null, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo lobortis eget.")))),
-        getByText = _render3.getByText,
-        getAllByRole = _render3.getAllByRole;
+        getByText = _render.getByText,
+        getAllByRole = _render.getAllByRole;
 
     expect(getAllByRole("button")[0].getAttribute("aria-expanded")).toBe("false");
     expect(getAllByRole("button")[1].getAttribute("aria-expanded")).toBe("false");
@@ -62,28 +35,29 @@ describe("Accordion component tests", function () {
     expect(getAllByRole("button")[0].getAttribute("aria-expanded")).toBe("true");
     expect(getAllByRole("button")[1].getAttribute("aria-expanded")).toBe("false");
   });
-  test("Uncontrolled accordion group renders initially with an accordion expanded", function () {
-    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], {
+  test("Uncontrolled accordion group renders initially with an accordion expanded using defaultIndexActive", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], {
       defaultIndexActive: 1
     }, /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"].Accordion, {
       label: "Accordion1",
       padding: "medium"
-    }, /*#__PURE__*/_react["default"].createElement("div", null, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo lobortis eget.")), /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"].Accordion, {
+    }, /*#__PURE__*/_react["default"].createElement("div", null, "First accordion")), /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"].Accordion, {
       label: "Accordion2",
       padding: "medium"
-    }, /*#__PURE__*/_react["default"].createElement("div", null, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo lobortis eget.")))),
-        getByText = _render4.getByText,
-        getAllByRole = _render4.getAllByRole;
+    }, /*#__PURE__*/_react["default"].createElement("div", null, "Second accordion")))),
+        queryByText = _render2.queryByText,
+        getByText = _render2.getByText,
+        getAllByRole = _render2.getAllByRole;
 
-    expect(getByText("Accordion1")).toBeTruthy();
-    expect(getByText("Accordion2")).toBeTruthy();
     expect(getAllByRole("button")[0].getAttribute("aria-expanded")).toBe("false");
     expect(getAllByRole("button")[1].getAttribute("aria-expanded")).toBe("true");
+    expect(getByText("Second accordion")).toBeTruthy();
+    expect(queryByText("First accordion")).toBeFalsy();
   });
   test("Controlled accordion with indexActive change", function () {
     var onActiveChange = jest.fn();
 
-    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], {
       margin: "large",
       indexActive: 1,
       onActiveChange: onActiveChange
@@ -95,11 +69,12 @@ describe("Accordion component tests", function () {
       label: "Accordion2",
       padding: "medium"
     }, /*#__PURE__*/_react["default"].createElement("div", null, "Text2")))),
-        getByText = _render5.getByText,
-        getAllByRole = _render5.getAllByRole,
-        rerender = _render5.rerender;
+        queryByText = _render3.queryByText,
+        getByText = _render3.getByText,
+        getAllByRole = _render3.getAllByRole,
+        rerender = _render3.rerender;
 
-    expect(getByText("Text1")).toBeTruthy();
+    expect(queryByText("Text1")).toBeFalsy();
     expect(getByText("Text2")).toBeTruthy();
 
     _react2.fireEvent.click(getByText("Accordion1"));
@@ -128,7 +103,7 @@ describe("Accordion component tests", function () {
   test("Disabled uncontrolled accordion group", function () {
     var onActiveChange = jest.fn();
 
-    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_AccordionGroup["default"], {
       margin: "large",
       onActiveChange: onActiveChange,
       disabled: true
@@ -140,7 +115,7 @@ describe("Accordion component tests", function () {
       label: "Accordion2",
       padding: "medium"
     }, /*#__PURE__*/_react["default"].createElement("div", null, "Text2")))),
-        getByText = _render6.getByText;
+        getByText = _render4.getByText;
 
     _react2.fireEvent.click(getByText("Accordion1"));
 

package/accordion-group/types.d.ts

@@ -12,7 +12,7 @@ declare type Padding = {
     left?: Space;
     right?: Space;
 };
-declare type SVG = React.SVGProps<SVGSVGElement>;
+declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
 export declare type AccordionPropsType = {
     /**
      * The panel label.
@@ -31,6 +31,7 @@ export declare type AccordionPropsType = {
      */
     disabled?: boolean;
     /**
+     * @deprecated This prop will be removed shortly, consider using the Inset component for this purpose.
      * Size of the padding to be applied to the custom area ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
      * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different padding sizes.
      */
@@ -69,4 +70,10 @@ declare type Props = {
      */
     children: React.ReactElement<AccordionPropsType>[] | React.ReactElement<AccordionPropsType>;
 };
+export declare type AccordionGroupAccordionContextProps = {
+    activeIndex: number;
+    handlerActiveChange: (index: number) => void;
+    disabled: boolean;
+    index: number;
+};
 export default Props;

package/alert/Alert.js

@@ -17,9 +17,9 @@ var _react = _interopRequireDefault(require("react"));
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
-var _variables = require("../common/variables.js");
+var _variables = require("../common/variables");
 
-var _utils = require("../common/utils.js");
+var _utils = require("../common/utils");
 
 var _useTheme = _interopRequireDefault(require("../useTheme"));
 
@@ -131,9 +131,7 @@ var DxcAlert = function DxcAlert(_ref) {
     size: size
   }, /*#__PURE__*/_react["default"].createElement(AlertInfo, null, /*#__PURE__*/_react["default"].createElement(AlertIcon, {
     type: type
-  }, type === "info" && alertIcons.info || type === "confirm" && alertIcons.success || type === "warning" && alertIcons.warning || type === "error" && alertIcons.error), /*#__PURE__*/_react["default"].createElement(AlertText, null, /*#__PURE__*/_react["default"].createElement(AlertTitle, {
-    type: type
-  }, getTypeText()), inlineText && inlineText !== "" && "-", /*#__PURE__*/_react["default"].createElement(AlertInlineText, null, inlineText)), onClose && /*#__PURE__*/_react["default"].createElement(AlertCloseAction, {
+  }, type === "info" && alertIcons.info || type === "confirm" && alertIcons.success || type === "warning" && alertIcons.warning || type === "error" && alertIcons.error), /*#__PURE__*/_react["default"].createElement(AlertText, null, /*#__PURE__*/_react["default"].createElement(AlertTitle, null, getTypeText()), inlineText && inlineText !== "" && "-", /*#__PURE__*/_react["default"].createElement(AlertInlineText, null, inlineText)), onClose && /*#__PURE__*/_react["default"].createElement(AlertCloseAction, {
     onClick: onClose,
     tabIndex: tabIndex
   }, alertIcons.close)), children && /*#__PURE__*/_react["default"].createElement(AlertContent, null, /*#__PURE__*/_react["default"].createElement(_BackgroundColorContext.BackgroundColorProvider, {
@@ -146,7 +144,7 @@ var sizes = {
   medium: "480px",
   large: "820px",
   fillParent: "100%",
-  fitContent: "auto"
+  fitContent: "fit-content"
 };
 
 var calculateWidth = function calculateWidth(margin, size) {
@@ -279,12 +277,10 @@ var AlertContent = _styledComponents["default"].div(_templateObject9 || (_templa
   return "".concat(props.theme.contentPaddingTop, " ").concat(props.theme.contentPaddingRight, " ").concat(props.theme.contentPaddingBottom, " ").concat(props.theme.contentPaddingLeft);
 });
 
-var AlertCloseAction = _styledComponents["default"].button(_templateObject10 || (_templateObject10 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-wrap: wrap;\n  align-content: center;\n  height: 24px;\n  width: 24px;\n  border: 1px solid transparent;\n  border-radius: 2px;\n  box-shadow: 0 0 0 2px transparent;\n  padding: 3px;\n  margin-left: 12px;\n  background-color: transparent;\n  color: #000000;\n  cursor: pointer;\n\n  &:hover {\n    background-color: ", ";\n  }\n  &:focus {\n    outline: none;\n    box-shadow: 0 0 0 2px ", ";\n  }\n  &:focus-visible {\n    outline: none;\n    box-shadow: 0 0 0 2px ", ";\n  }\n  &:active {\n    background-color: ", ";\n  }\n"])), function (props) {
+var AlertCloseAction = _styledComponents["default"].button(_templateObject10 || (_templateObject10 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-wrap: wrap;\n  align-content: center;\n  height: 24px;\n  width: 24px;\n  border: 1px solid transparent;\n  border-radius: 2px;\n  box-shadow: 0 0 0 2px transparent;\n  padding: 3px;\n  margin-left: 12px;\n  background-color: transparent;\n  color: #000000;\n  cursor: pointer;\n\n  &:hover {\n    background-color: ", ";\n  }\n  &:focus,\n  &:focus-visible {\n    outline: none;\n    box-shadow: 0 0 0 2px ", ";\n  }\n  &:active {\n    background-color: ", ";\n  }\n"])), function (props) {
   return props.theme.hoverActionBackgroundColor;
 }, function (props) {
   return props.theme.focusActionBorderColor;
-}, function (props) {
-  return props.theme.focusActionBorderColor;
 }, function (props) {
   return props.theme.activeActionBackgroundColor;
 });

package/alert/Alert.stories.tsx

@@ -2,12 +2,21 @@ import React from "react";
 import DxcAlert from "./Alert";
 import Title from "../../.storybook/components/Title";
 import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import { HalstackProvider } from "../HalstackContext";
 
 export default {
   title: "Alert",
   component: DxcAlert,
 };
 
+const opinionatedTheme = {
+  alert: {
+    baseColor: "#e6f4ff",
+    accentColor: "#0067b3",
+    overlayColor: "#000000b3",
+  },
+};
+
 export const Chromatic = () => (
   <>
     <ExampleContainer>
@@ -155,6 +164,12 @@ export const Chromatic = () => (
         </div>
       </DxcAlert>
     </ExampleContainer>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcAlert inlineText="Info type alert with inline text." />
+      </HalstackProvider>
+    </ExampleContainer>
   </>
 );
 
@@ -168,3 +183,16 @@ export const ModalAlert = () => (
     </DxcAlert>
   </ExampleContainer>
 );
+
+export const ModalAlertOpinionated = () => (
+  <ExampleContainer>
+    <HalstackProvider theme={opinionatedTheme}>
+      <DxcAlert inlineText="Modal alert." mode="modal" onClose={() => {}}>
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAlert>
+    </HalstackProvider>
+  </ExampleContainer>
+);

package/alert/Alert.test.js

@@ -6,7 +6,7 @@ var _react = _interopRequireDefault(require("react"));
 
 var _react2 = require("@testing-library/react");
 
-var _Alert = _interopRequireDefault(require("./Alert"));
+var _Alert = _interopRequireDefault(require("./Alert.tsx"));
 
 describe("Alert component tests", function () {
   test("Info alert renders with correct text", function () {

package/bleed/Bleed.stories.tsx

@@ -337,5 +337,6 @@ const Placeholder = styled.div`
   min-height: 40px;
   min-width: 120px;
   border: 1px solid #a46ede;
+  border-radius: 0.5rem;
   background-color: #e5d5f6;
 `;

package/box/Box.js

@@ -17,9 +17,9 @@ var _react = _interopRequireDefault(require("react"));
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
-var _variables = require("../common/variables.js");
+var _variables = require("../common/variables");
 
-var _utils = require("../common/utils.js");
+var _utils = require("../common/utils");
 
 var _useTheme = _interopRequireDefault(require("../useTheme"));
 
@@ -60,7 +60,7 @@ var sizes = {
   medium: "240px",
   large: "480px",
   fillParent: "100%",
-  fitContent: "unset"
+  fitContent: "fit-content"
 };
 
 var calculateWidth = function calculateWidth(margin, size, padding) {
@@ -71,7 +71,7 @@ var calculateWidth = function calculateWidth(margin, size, padding) {
   return sizes[size];
 };
 
-var StyledDxcBox = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: ", ";\n  border-radius: ", ";\n  border-width: ", ";\n  border-style: ", ";\n  border-color: ", ";\n  letter-spacing: ", ";\n  overflow: hidden;\n  width: ", ";\n  background-color: ", ";\n  box-shadow: ", ";\n\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n\n  padding: ", ";\n  padding-top: ", ";\n  padding-right: ", ";\n  padding-bottom: ", ";\n  padding-left: ", ";\n"])), function (props) {
+var StyledDxcBox = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: ", ";\n  border-radius: ", ";\n  border-width: ", ";\n  border-style: ", ";\n  border-color: ", ";\n  overflow: hidden;\n  width: ", ";\n  background-color: ", ";\n  box-shadow: ", ";\n\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n\n  padding: ", ";\n  padding-top: ", ";\n  padding-right: ", ";\n  padding-bottom: ", ";\n  padding-left: ", ";\n"])), function (props) {
   return props.display;
 }, function (props) {
   return props.theme.borderRadius;
@@ -81,8 +81,6 @@ var StyledDxcBox = _styledComponents["default"].div(_templateObject || (_templat
   return props.theme.borderStyle;
 }, function (props) {
   return props.theme.borderColor;
-}, function (props) {
-  return props.theme.letterSpacing;
 }, function (props) {
   return calculateWidth(props.margin, props.size, props.padding);
 }, function (props) {

package/box/Box.stories.tsx

@@ -2,12 +2,19 @@ import React from "react";
 import Title from "../../.storybook/components/Title";
 import ExampleContainer from "../../.storybook/components/ExampleContainer";
 import DxcBox from "./Box";
+import { HalstackProvider } from "../HalstackContext";
 
 export default {
   title: "Box ",
   component: DxcBox,
 };
 
+const opinionatedTheme = {
+  box: {
+    baseColor: "#ffffff",
+  },
+};
+
 export const Chromatic = () => (
   <>
     <Title title="Display flex" theme="light" level={2} />
@@ -128,5 +135,13 @@ export const Chromatic = () => (
       <Title title="FitContent" theme="light" level={4} />
       <DxcBox size="fitContent">Box</DxcBox>
     </ExampleContainer>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcBox display="flex" padding="medium">
+          Box
+        </DxcBox>
+      </HalstackProvider>
+    </ExampleContainer>
   </>
 );

package/box/Box.test.js

@@ -6,7 +6,7 @@ var _react = _interopRequireDefault(require("react"));
 
 var _react2 = require("@testing-library/react");
 
-var _Card = _interopRequireDefault(require("../card/Card"));
+var _Card = _interopRequireDefault(require("../card/Card.tsx"));
 
 describe("Box component tests", function () {
   test("Box renders with correct text", function () {

package/box/types.d.ts

@@ -31,6 +31,7 @@ declare type Props = {
      */
     margin?: Space | Margin;
     /**
+     * @deprecated This prop will be removed shortly, consider using the Inset component for this purpose.
      * Size of the padding to be applied to the custom area ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
      * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different padding sizes.
      */

package/bulleted-list/BulletedList.js

@@ -57,7 +57,9 @@ var DxcBulletedList = function DxcBulletedList(_ref2) {
       backgroundType: backgroundType
     })) : type === "icon" ? /*#__PURE__*/_react["default"].createElement(Bullet, null, /*#__PURE__*/_react["default"].createElement(Icon, {
       backgroundType: backgroundType
-    }, icon)) : /*#__PURE__*/_react["default"].createElement(Bullet, null, /*#__PURE__*/_react["default"].createElement(Disc, {
+    }, typeof icon === "string" ? /*#__PURE__*/_react["default"].createElement("img", {
+      src: icon
+    }) : icon)) : /*#__PURE__*/_react["default"].createElement(Bullet, null, /*#__PURE__*/_react["default"].createElement(Disc, {
       backgroundType: backgroundType
     })), /*#__PURE__*/_react["default"].createElement(_Typography["default"], {
       color: backgroundType && backgroundType === "dark" ? colorsTheme.bulletedList.fontColorOnDark : colorsTheme.bulletedList.fontColor
@@ -73,7 +75,7 @@ var Bullet = _styledComponents["default"].div(_templateObject2 || (_templateObje
 
 var GeneralContent = _styledComponents["default"].div(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  display: grid;\n  grid-template-columns: auto 1fr;\n  align-items: center;\n"])));
 
-var Icon = _styledComponents["default"].div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  height: 1.5rem;\n  width: auto;\n  margin-right: ", ";\n  align-content: center;\n  color: ", ";\n  & > svg {\n    height: ", ";\n    width: ", ";\n  }\n"])), function (props) {
+var Icon = _styledComponents["default"].div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  height: 1.5rem;\n  width: auto;\n  margin-right: ", ";\n  align-content: center;\n  color: ", ";\n  svg,\n  img {\n    height: ", ";\n    width: ", ";\n  }\n"])), function (props) {
   return props.theme.bulletMarginRight;
 }, function (props) {
   return props.backgroundType && props.backgroundType === "dark" ? props.theme.fontColorOnDark : props.theme.fontColor;

package/bulleted-list/BulletedList.stories.tsx

@@ -20,12 +20,18 @@ const icon = (
 export const Chromatic = () => (
   <>
     <ExampleContainer>
-      <Title title="Icon list" level={4} />
+      <Title title="Icon list (SVG)" level={4} />
       <DxcBulletedList type="icon" icon={icon}>
         <DxcBulletedList.Item>Code</DxcBulletedList.Item>
         <DxcBulletedList.Item>Usage</DxcBulletedList.Item>
         <DxcBulletedList.Item>Specifications</DxcBulletedList.Item>
       </DxcBulletedList>
+      <Title title="Icon list (path)" level={4} />
+      <DxcBulletedList type="icon" icon="https://upload.wikimedia.org/wikipedia/commons/e/e0/Check_green_icon.svg">
+        <DxcBulletedList.Item>Code</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Usage</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Specifications</DxcBulletedList.Item>
+      </DxcBulletedList>
       <Title title="Number list" level={4} />
       <DxcBulletedList type="number">
         <DxcBulletedList.Item>Code</DxcBulletedList.Item>

package/bulleted-list/types.d.ts

@@ -1,11 +1,38 @@
 /// <reference types="react" />
-declare type SVG = React.SVGProps<SVGSVGElement> | React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
-declare type Props = {
+declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+declare type IconProps = {
+    /**
+     * Defines the style of the bullet point in the list.
+     */
+    type: "icon";
+    /**
+     * Icon to display as bullet.
+     */
+    icon: string | SVG;
+    /**
+     * Text to be shown in the list.
+     */
     children: React.ReactNode;
-    type?: "disc" | "circle" | "square" | "number" | "icon";
-    icon?: string | SVG;
 };
+declare type OtherProps = {
+    /**
+     * Defines the style of the bullet point in the list.
+     */
+    type?: "disc" | "circle" | "square" | "number";
+    /**
+     * Icon to display as bullet.
+     */
+    icon?: never;
+    /**
+     * Text to be shown in the list.
+     */
+    children: React.ReactNode;
+};
+declare type Props = IconProps | OtherProps;
 export default Props;
 export declare type BulletedListItemPropsType = {
+    /**
+     * Text to be shown in the list.
+     */
     children?: React.ReactNode;
 };