@bonprix-ds/internal-components 0.0.2 → 0.1.1

package/dist/index.d.ts

@@ -1,48 +1,117 @@
-import { Anchor } from '@bonprix-ds/utils';
 import { ButtonSize } from '@bonprix-ds/utils';
-import { ButtonTypeAttribute } from '@bonprix-ds/utils';
+import { ComponentProps } from 'react';
 import { default as default_2 } from 'react';
+import { ElementType } from 'react';
+import { FC } from 'react';
 import { IconType } from '@bonprix-ds/react-icon';
 import { Ref } from 'react';
+import { ControlGroupProps as SelectionControlGroupProps } from '@bonprix-ds/utils';
 
-declare interface AsButton extends BaseProps {
-    link?: false;
-    onClick?: (event: default_2.MouseEvent<HTMLButtonElement>) => void;
-    type?: ButtonTypeAttribute;
-    form?: string;
-    ref?: Ref<HTMLButtonElement>;
-    rel?: never;
-    href?: never;
-    target?: never;
+declare interface AllyIds {
+    errorTextId: string;
+    helperTextId: string;
 }
 
-declare interface AsLink extends BaseProps, Anchor {
-    link: true;
-    onClick?: (event: default_2.MouseEvent<HTMLAnchorElement>) => void;
-    ref?: Ref<HTMLAnchorElement>;
-    type?: never;
-    form?: never;
-}
-
-export declare const BaseButton: ({ id, children, size, disabled, variant, contentWidth, loading, icon, iconPosition, iconButton, tabIndex, className, componentName, inverted, ...unionProps }: BaseButtonProps) => default_2.JSX.Element;
+export declare const BaseButton: <C extends ElementType = "button">({ children, size, variant, contentWidth, loading, icon, iconPosition, componentName, inverted, component, ...props }: BaseButtonProps<C>) => default_2.JSX.Element;
 
-export declare type BaseButtonProps = AsButton | AsLink;
+export declare type BaseButtonProps<C extends ElementType> = BaseProps & {
+    component?: C;
+} & Omit<ComponentProps<C>, keyof BaseProps | "component">;
 
 declare interface BaseProps {
     children: string;
-    id?: string;
     size?: ButtonSize;
-    disabled?: boolean;
     variant?: "primary" | "secondary" | "tertiary";
     contentWidth?: boolean;
     loading?: boolean;
     icon?: IconType;
     iconPosition?: "start" | "end";
-    iconButton?: boolean;
-    tabIndex?: number;
-    className?: string;
     componentName?: "button" | "icon-button" | "badge-icon-button";
     inverted?: boolean;
 }
 
+declare interface BaseProps_2 {
+    label: string;
+    /** The name of the checkbox. Will be submitted with the form. */
+    name: string;
+    /** Callback function that is called when the checkbox loses focus. */
+    onBlur?: () => void;
+    /** The id of the checkbox. */
+    id?: string;
+    /** Value that will be submitted when the form is submitted. */
+    value?: string;
+    /** If set to `true`, the checkbox will be marked as required. */
+    required?: boolean;
+    /** If set to `true`, the checkbox will be disabled. */
+    disabled?: boolean;
+    /** If set to `true`, the checkbox will be marked as erroneous. */
+    error?: boolean;
+    errorText?: string;
+    helperText?: string;
+    /** A reference to the root element of the checkbox. Helpful for intergrating with 3rd party form libraries like react-hook-form. */
+    rootRef?: Ref<HTMLInputElement>;
+    /** <a href="https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby" target="_blank">ARIA: aria-describedby attribute.</a> */
+    describedBy?: string;
+}
+
+export declare const CheckboxBase: FC<CheckboxBaseProps & AllyIds>;
+
+export declare type CheckboxBaseProps = ControlledInputProps | UncontrolledInputProps;
+
+declare interface ControlledInputProps extends BaseProps_2 {
+    /** Controls, whether the checkbox is checked or not. Should be used in conjunction with `onChange`. */
+    checked: boolean;
+    /** Initial value of the checkbox. Should be used for uncontrolled variant of the component. */
+    defaultChecked?: never;
+    /** Callback function that is called when the checkbox state changes. `checked` should be adjusted appropriately. */
+    onChange: (value: boolean) => void;
+}
+
+export declare const InputHelperText: FC<InputHelperTextProps>;
+
+export declare interface InputHelperTextProps {
+    id: string;
+    children: string;
+    type?: "description" | "error";
+}
+
+export declare const InputHelperTextSection: FC<InputHelperTextSectionProps>;
+
+export declare interface InputHelperTextSectionProps {
+    helperText: string;
+    helperTextId: string;
+    error: boolean;
+    errorText: string;
+    errorTextId: string;
+    className?: string;
+}
+
+export declare const InputWrapper: FC<InputWrapperProps>;
+
+export declare interface InputWrapperProps {
+    children: default_2.ReactNode;
+    id: string;
+    labelFloated: boolean;
+    disabled: boolean;
+    required: boolean;
+    componentName: "select" | "password-field" | "text-field" | "search-field" | "textarea";
+    label?: string;
+    helperText: string;
+    helperTextId: string;
+    error: boolean;
+    errorText: string;
+    errorTextId: string;
+    labelClassName?: string;
+}
+
+export declare const SelectionControlGroup: FC<SelectionControlGroupProps>;
+
+export { SelectionControlGroupProps }
+
+declare interface UncontrolledInputProps extends BaseProps_2 {
+    checked?: never;
+    defaultChecked: boolean;
+    onChange?: (value: boolean) => void;
+}
+
 export { }