@bonprix-ds/react-list 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { FC } from 'react';
+import { IconType } from '@bonprix-ds/react-icon';
+import { ReactNode } from 'react';
+
+declare const List: FC<ListProps> & Subcomponents;
+export default List;
+
+declare const ListItem: FC<Props>;
+
+export declare interface ListProps {
+    /** The content of the list. Here, List.Item should be used. */
+    children: ReactNode;
+    /** Defines the type of the list. The type can only be set for the whole list, not for individual items. */
+    type?: "text" | "button" | "link";
+    /** If set to `true`, the list items will show an arrow in the end. */
+    showArrows?: boolean;
+    /** Additional classes for further customization. */
+    className?: string;
+}
+
+declare interface Props {
+    /** The text content of the list item. */
+    children: string;
+    /** The icon to display in front of the list item. */
+    icon?: IconType;
+    /** Callback function to be called when the list item is clicked. */
+    onClick?: () => void;
+    /** If the `type` property of the List is set to `link`, this property is used to set the `href` attribute. */
+    href?: string;
+    /** If the `type` property of the List is set to `link`, this property is used to set the `target` attribute. */
+    target?: "_blank" | "_self" | "_parent" | "_top";
+}
+
+declare interface Subcomponents {
+    Item: typeof ListItem;
+}
+
+export { }