@mittwald/flow-react-components 0.1.0-alpha.386 → 0.1.0-alpha.387

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.1.0-alpha.387](https://github.com/mittwald/flow/compare/0.1.0-alpha.386...0.1.0-alpha.387) (2024-12-18)
+
+**Note:** Version bump only for package @mittwald/flow-react-components
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
 # [0.1.0-alpha.386](https://github.com/mittwald/flow/compare/0.1.0-alpha.385...0.1.0-alpha.386) (2024-12-18)
 
 ### Features

package/dist/js/types/components/Accordion/Accordion.d.ts

@@ -1,6 +1,8 @@
 import { ComponentProps, FC, PropsWithChildren } from 'react';
 export interface AccordionProps extends PropsWithChildren<ComponentProps<"div">> {
+    /** Whether the accordion should be initially expanded. */
     defaultExpanded?: boolean;
+    /** The visual variant of the accordion. @default "default" */
     variant?: "default" | "outline";
 }
 export declare const Accordion: FC<AccordionProps>;

package/dist/js/types/components/ActionGroup/ActionGroup.d.ts

@@ -2,7 +2,9 @@ import { PropsWithChildren, default as React } from 'react';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 import { PropsWithClassName } from '../../lib/types/props';
 export interface ActionGroupProps extends PropsWithChildren, FlowComponentProps, PropsWithClassName {
+    /** Whether the breakpoints for a compact version should be ignored. */
     ignoreBreakpoint?: boolean;
+    /** The spacing between the buttons inside the action group. @default "m" */
     spacing?: "s" | "m";
 }
 export declare const ActionGroup: React.ForwardRefExoticComponent<ActionGroupProps & React.RefAttributes<never>>;

package/dist/js/types/components/Avatar/Avatar.d.ts

@@ -4,8 +4,9 @@ import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 export declare const avatarColors: readonly ["blue", "teal", "green", "violet", "lilac"];
 export type AvatarColors = (typeof avatarColors)[number];
 export interface AvatarProps extends PropsWithChildren, PropsWithClassName, FlowComponentProps {
-    /** @default "m" */
+    /** The size of the avatar. @default "m" */
     size?: "xs" | "s" | "m" | "l";
+    /** The color of icons and initials inside the avatar. */
     color?: AvatarColors;
 }
 export declare const Avatar: React.ForwardRefExoticComponent<AvatarProps & React.RefAttributes<never>>;

package/dist/js/types/components/Badge/Badge.d.ts

@@ -5,9 +5,13 @@ import { PressEvent } from '@react-types/shared';
 export declare const badgeColors: readonly ["neutral", "blue", "navy", "violet", "teal", "lilac", "green", "orange", "red", "dark", "light"];
 export type BadgeColors = (typeof badgeColors)[number];
 export interface BadgeProps extends PropsWithChildren, FlowComponentProps, PropsWithClassName {
+    /** Handler that is called when the badge is pressed. */
     onPress?: (e: PressEvent) => void;
+    /** Handler that is called when the badges close icon is pressed. */
     onClose?: (e: PressEvent) => void;
+    /** The color of the badge. @default "neutral" */
     color?: BadgeColors;
+    /** Whether the badge is disabled. */
     isDisabled?: boolean;
 }
 export declare const Badge: React.ForwardRefExoticComponent<BadgeProps & React.RefAttributes<never>>;

package/dist/js/types/components/Breadcrumb/Breadcrumb.d.ts

@@ -2,7 +2,7 @@ import { FC, PropsWithChildren } from 'react';
 import { BreadcrumbItemProps } from './components/BreadcrumbItem';
 import * as Aria from "react-aria-components";
 export interface BreadcrumbProps extends Omit<Aria.BreadcrumbsProps<BreadcrumbItemProps>, "children">, PropsWithChildren {
-    /** @default "primary" */
+    /** The color of the breadcrumb. @default "primary" */
     color?: "primary" | "dark" | "light";
 }
 export declare const Breadcrumb: FC<BreadcrumbProps>;

package/dist/js/types/components/Button/Button.d.ts

@@ -2,16 +2,21 @@ import { PropsWithChildren, default as React } from 'react';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 import * as Aria from "react-aria-components";
 export interface ButtonProps extends PropsWithChildren<Aria.ButtonProps>, FlowComponentProps {
+    /** Slot for button placement in action groups. */
     slot?: string;
-    /** @default "primary" */
+    /** The color of the button. @default "primary" */
     color?: "primary" | "accent" | "secondary" | "danger" | "dark" | "light";
-    /** @default "solid" */
+    /** The visual variant of the button. @default "solid" */
     variant?: "plain" | "solid" | "soft" | "outline";
-    /** @default "m" */
+    /** The size of the button. @default "m" */
     size?: "m" | "s";
+    /** Disables button but keeps it focusable. */
     "aria-disabled"?: boolean;
+    /** Whether the button is in a pending state. */
     isPending?: boolean;
+    /** Whether the button is in a succeeded state. */
     isSucceeded?: boolean;
+    /** Whether the button is in a failed state. */
     isFailed?: boolean;
 }
 export declare const Button: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<never>>;

package/dist/js/types/components/CodeBlock/CodeBlock.d.ts

@@ -2,8 +2,11 @@ import { FC } from 'react';
 import { SyntaxHighlighterProps } from 'react-syntax-highlighter';
 import { PropsWithClassName } from '../../lib/types/props';
 export interface CodeBlockProps extends Omit<SyntaxHighlighterProps, "children">, PropsWithClassName {
+    /** Adds a copy icon to the code block to copy its content. */
     copyable?: boolean;
+    /** The color of the code block. @default "default" */
     color?: "default" | "light" | "dark";
+    /** The code to display inside the code block. */
     code: string | string[];
 }
 export declare const CodeBlock: FC<CodeBlockProps>;

package/dist/js/types/components/ColumnLayout/ColumnLayout.d.ts

@@ -2,11 +2,22 @@ import { FC, PropsWithChildren } from 'react';
 import { PropsWithClassName, PropsWithElementType } from '../../lib/types/props';
 type GapSize = "s" | "m" | "l" | "xl";
 export interface ColumnLayoutProps extends PropsWithChildren, PropsWithElementType<"div" | "ul">, PropsWithClassName {
+    /** Column layout for container size s. */
     s?: number[];
+    /** Column layout for container size m. */
     m?: number[];
+    /** Column layout for container size l. */
     l?: number[];
+    /**
+     * Size of the row and column gap between the content blocks inside the column
+     * layout.
+     *
+     * @default "m"
+     */
     gap?: GapSize;
+    /** Size of the row gap between the content blocks inside the column layout. */
     rowGap?: GapSize;
+    /** Size of the column gap between the content blocks inside the column layout. */
     columnGap?: GapSize;
 }
 export declare const ColumnLayout: FC<ColumnLayoutProps>;

package/dist/js/types/components/ContextMenu/ContextMenu.d.ts

@@ -4,7 +4,9 @@ import { PopoverProps } from '../Popover';
 import { MenuItemProps } from '../MenuItem';
 import * as Aria from "react-aria-components";
 export interface ContextMenuProps extends Omit<PopoverProps, "withTip">, Pick<Aria.MenuProps<MenuItemProps>, "onAction" | "selectedKeys" | "defaultSelectedKeys" | "onSelectionChange" | "disabledKeys">, FlowComponentProps {
+    /** The type of selection that is allowed in the context menu. */
     selectionMode?: "single" | "multiple" | "navigation";
+    /** Sets the context menu to a fixed width. */
     width?: string | number;
 }
 export declare const ContextMenu: React.ForwardRefExoticComponent<ContextMenuProps & React.RefAttributes<never>>;

package/dist/js/types/components/CopyButton/CopyButton.d.ts

@@ -2,6 +2,7 @@ import { ReactNode, default as React } from 'react';
 import { ButtonProps } from '../Button';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 export interface CopyButtonProps extends Omit<ButtonProps, "onPress" | "aria-label" | "render">, FlowComponentProps {
+    /** The text to copy. */
     text: ReactNode;
 }
 export declare const CopyButton: React.ForwardRefExoticComponent<CopyButtonProps & React.RefAttributes<never>>;

package/dist/js/types/components/CounterBadge/CounterBadge.d.ts

@@ -2,6 +2,7 @@ import { default as React } from 'react';
 import { PropsWithElementType } from '../../lib/types/props';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 export interface CounterBadgeProps extends PropsWithElementType<"span">, FlowComponentProps {
+    /** The number displayed inside the badge. */
     count?: number;
 }
 export declare const CounterBadge: React.ForwardRefExoticComponent<CounterBadgeProps & React.RefAttributes<never>>;

package/dist/js/types/components/DatePicker/DatePicker.d.ts

@@ -1,6 +1,7 @@
 import { PropsWithChildren, ReactNode, default as React } from 'react';
 import * as Aria from "react-aria-components";
 export interface DatePickerProps<T extends Aria.DateValue> extends PropsWithChildren<Omit<Aria.DatePickerProps<T>, "children">> {
+    /** The error message that is displayed below the input. */
     errorMessage?: ReactNode;
 }
 export declare const DatePicker: React.ForwardRefExoticComponent<DatePickerProps<Aria.DateValue> & React.RefAttributes<never>>;

package/dist/js/types/components/DateRangePicker/DateRangePicker.d.ts

@@ -1,6 +1,7 @@
 import { PropsWithChildren, ReactNode, default as React } from 'react';
 import * as Aria from "react-aria-components";
 export interface DateRangePickerProps<T extends Aria.DateValue> extends PropsWithChildren<Omit<Aria.DateRangePickerProps<T>, "children">> {
+    /** The error message that is displayed below the input. */
     errorMessage?: ReactNode;
 }
 export declare const DateRangePicker: React.ForwardRefExoticComponent<DateRangePickerProps<Aria.DateValue> & React.RefAttributes<never>>;

package/dist/js/types/components/FileCard/FileCard.d.ts

@@ -2,10 +2,15 @@ import { default as React } from 'react';
 import { PropsWithClassName, PropsWithElementType } from '../../lib/types/props';
 import { LinkProps } from '../Link';
 export interface FileCardProps extends PropsWithClassName, PropsWithElementType<"div" | "li">, Pick<LinkProps, "onPress" | "href" | "target" | "download"> {
+    /** The name of the file. */
     name: string;
+    /** The type of the file. */
     type?: string;
+    /** Handler that is called when the file cards delete button is clicked. */
     onDelete?: () => void;
+    /** The size of the file in bytes. */
     sizeInBytes?: number;
+    /** The source of an image file. */
     imageSrc?: string;
 }
 export declare const FileCard: React.ForwardRefExoticComponent<FileCardProps & React.RefAttributes<never>>;

package/dist/js/types/components/FileField/FileField.d.ts

@@ -3,6 +3,7 @@ import { FileInputOnChangeHandler } from './components/FileInput';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 import type * as Aria from "react-aria-components";
 export interface FileFieldProps extends PropsWithChildren, FlowComponentProps, Pick<Aria.InputProps, "accept" | "multiple" | "name">, Pick<Aria.TextFieldProps, "isRequired" | "isInvalid" | "validationBehavior" | "isDisabled"> {
+    /** Handler that is called when the file input changes. */
     onChange?: FileInputOnChangeHandler;
 }
 export declare const FileField: React.ForwardRefExoticComponent<FileFieldProps & React.RefAttributes<never>>;

package/dist/js/types/components/HeaderNavigation/HeaderNavigation.d.ts

@@ -1,7 +1,7 @@
 import { ComponentProps, FC, PropsWithChildren } from 'react';
 import { PropsWithClassName } from '../../lib/types/props';
 export interface HeaderNavigationProps extends PropsWithChildren<ComponentProps<"nav">>, PropsWithClassName {
-    /** @default "primary" */
+    /** The color of the header navigation. @default "primary" */
     color?: "primary" | "dark" | "light";
 }
 export declare const HeaderNavigation: FC<HeaderNavigationProps>;

package/dist/js/types/components/Heading/Heading.d.ts

@@ -2,8 +2,9 @@ import { default as React } from 'react';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 import * as Aria from "react-aria-components";
 export interface HeadingProps extends Aria.HeadingProps, FlowComponentProps {
+    /** The font size of the heading. */
     size?: "xs" | "s" | "m" | "l" | "xl" | "xxl";
-    /** @default "primary" */
+    /** The color of the heading. @default "primary" */
     color?: "primary" | "dark" | "light";
 }
 export declare const Heading: React.ForwardRefExoticComponent<HeadingProps & React.RefAttributes<never>>;

package/dist/js/types/components/Icon/Icon.d.ts

@@ -2,7 +2,7 @@ import { PropsWithChildren, SVGAttributes, default as React } from 'react';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 type SvgAttributeProps = SVGAttributes<SVGSVGElement>;
 export interface IconProps extends PropsWithChildren<Omit<SvgAttributeProps, "name">>, FlowComponentProps {
-    /** @default "m" */
+    /** The size of the icon. @default "m" */
     size?: "s" | "m" | "l";
 }
 export declare const Icon: React.ForwardRefExoticComponent<IconProps & React.RefAttributes<never>>;

package/dist/js/types/components/IllustratedMessage/IllustratedMessage.d.ts

@@ -1,6 +1,6 @@
 import { ComponentProps, FC, PropsWithChildren } from 'react';
 export interface IllustratedMessageProps extends PropsWithChildren<ComponentProps<"div">> {
-    /** @default "primary" */
+    /** The color of the illustrated message. @default "primary" */
     color?: "primary" | "danger" | "light" | "dark";
 }
 export declare const IllustratedMessage: FC<IllustratedMessageProps>;

package/dist/js/types/components/InlineCode/InlineCode.d.ts

@@ -1,5 +1,6 @@
 import { ComponentProps, FC, PropsWithChildren } from 'react';
 export interface InlineCodeProps extends PropsWithChildren<ComponentProps<"code">> {
+    /** The color schema of the inline code component. */
     color?: "default" | "light" | "dark";
 }
 export declare const InlineCode: FC<InlineCodeProps>;

package/dist/js/types/components/Label/Label.d.ts

@@ -2,7 +2,9 @@ import { PropsWithChildren, default as React } from 'react';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 import * as Aria from "react-aria-components";
 export interface LabelProps extends PropsWithChildren<Omit<Aria.LabelProps, "children">>, FlowComponentProps {
+    /** Whether the label should show an "optional" indicator. */
     optional?: boolean;
+    /** Whether the label should be displayed as disabled. */
     isDisabled?: boolean;
 }
 export declare const Label: React.ForwardRefExoticComponent<LabelProps & React.RefAttributes<never>>;

package/dist/js/types/components/LightBox/LightBox.d.ts

@@ -3,7 +3,12 @@ import { PropsWithChildren, default as React } from 'react';
 import { PropsWithClassName } from '../../lib/types/props';
 import { OverlayController } from '../../lib/controller';
 export interface LightBoxProps extends PropsWithChildren, FlowComponentProps, PropsWithClassName {
+    /** An overlay controller to control the light box state. */
     controller?: OverlayController;
+    /**
+     * Whether content can be displayed larger than the available space in the
+     * screen. @default true
+     */
     fitScreen?: boolean;
 }
 export declare const LightBox: React.ForwardRefExoticComponent<LightBoxProps & React.RefAttributes<never>>;

package/dist/js/types/components/Link/Link.d.ts

@@ -3,9 +3,11 @@ import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 import { PropsWithClassName } from '../../lib/types/props';
 import * as Aria from "react-aria-components";
 export interface LinkProps extends PropsWithChildren<Omit<Aria.LinkProps, "children" | "slot" | "className">>, FlowComponentProps, PropsWithClassName {
+    /** Whether the link should be styled for being displayed inside a text. */
     inline?: boolean;
+    /** An alternative link component. */
     linkComponent?: ComponentType<Omit<ComponentProps<"a">, "ref">>;
-    /** @default "primary" */
+    /** The color of the link. @default "primary" */
     color?: "primary" | "dark" | "light";
     "aria-current"?: string;
 }

package/dist/js/types/components/List/List.d.ts

@@ -1,6 +1,7 @@
 import { PropsWithChildren, default as React } from 'react';
 import { ListShape } from './model/types';
 export interface ListProps<T> extends PropsWithChildren, Omit<ListShape<T>, "search" | "loader" | "itemView" | "table" | "batchesController" | "filters" | "sorting"> {
+    /** The number of items to be displayed on one page. */
     batchSize?: number;
 }
 export declare const List: React.ForwardRefExoticComponent<ListProps<never> & React.RefAttributes<never>>;

package/dist/js/types/components/Markdown/Markdown.d.ts

@@ -1,6 +1,7 @@
 import { FC } from 'react';
 import { Options } from 'react-markdown';
 export interface MarkdownProps extends Omit<Options, "components"> {
+    /** The color schema of the markdown component. */
     color?: "dark" | "light" | "default";
 }
 export declare const Markdown: FC<MarkdownProps>;

package/dist/js/types/components/Message/Message.d.ts

@@ -1,8 +1,9 @@
 import { FC, PropsWithChildren } from 'react';
 import { PropsWithClassName } from '../../lib/types/props';
 export interface MessageProps extends PropsWithChildren, PropsWithClassName {
-    /** @default "sender" */
+    /** Determines the color of the message. @default "sender" */
     type?: "responder" | "sender";
+    /** The orientation of the chat message. */
     orientation?: "left" | "right";
 }
 export declare const Message: FC<MessageProps>;

package/dist/js/types/components/Modal/Modal.d.ts

@@ -3,12 +3,23 @@ import { OverlayController } from '../../lib/controller/overlay';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 import { PropsWithClassName } from '../../lib/types/props';
 export interface ModalProps extends PropsWithChildren, FlowComponentProps, PropsWithClassName {
-    /** @default "s" */
+    /** The size of the modal. @default "s" */
     size?: "s" | "m";
+    /** Whether the modal should be displayed as an off canvas. */
     offCanvas?: boolean;
+    /**
+     * Whether the off canvas should be displayed on the right or left side of the
+     * screen. @default "right"
+     */
     offCanvasOrientation?: "left" | "right";
+    /** An overlay controller to control the modal state. */
     controller?: OverlayController;
+    /**
+     * Accepts "actionConfirm" to use the modal as a confirmation modal for an
+     * action.
+     */
     slot?: string;
+    /** Whether the modal can be closed by clicking outside of it. */
     isDismissable?: boolean;
 }
 export declare const Modal: React.ForwardRefExoticComponent<ModalProps & React.RefAttributes<never>>;

package/dist/js/types/components/Notification/Notification.d.ts

@@ -1,9 +1,16 @@
 import { ComponentProps, FC, PropsWithChildren } from 'react';
 import { PropsWithStatus } from '../../lib/types/props';
 export interface NotificationProps extends PropsWithChildren<ComponentProps<"div">>, PropsWithStatus {
+    /** A link that is triggered when clicking the notification. */
     href?: string;
+    /** Whether the notification should disappear automatically after some time. */
     autoClose?: boolean;
+    /** Handler that is called when the notification is clicked. */
     onClick?: () => void;
+    /**
+     * Handler that is called when the close button of the notification is
+     * clicked.
+     */
     onClose?: () => void;
 }
 export declare const Notification: FC<NotificationProps>;

package/dist/js/types/components/Overlay/Overlay.d.ts

@@ -1,9 +1,12 @@
 import { FC, PropsWithChildren } from 'react';
 import { OverlayController } from '../../lib/controller';
-export interface OverlayProps extends PropsWithChildren {
+import { PropsWithClassName } from '../../lib/types/props';
+export interface OverlayProps extends PropsWithChildren, PropsWithClassName {
+    /** The controller to control the overlay state. */
     controller?: OverlayController;
+    /** Whether the overlay can be closed by clicking outside of it. */
     isDismissable?: boolean;
-    className?: string;
+    /** Whether the overlay is a modal or a light box. */
     overlayType?: "Modal" | "LightBox";
 }
 export declare const Overlay: FC<OverlayProps>;

package/dist/js/types/components/OverlayTrigger/OverlayTrigger.d.ts

@@ -1,4 +1,4 @@
-import { ComponentType, FC, ReactNode } from 'react';
+import { ComponentType, FC, PropsWithChildren, ReactNode } from 'react';
 import { OverlayController } from '../../lib/controller';
 import { FlowComponentName } from '../propTypes';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
@@ -6,9 +6,10 @@ type AriaComponentType = ComponentType<{
     isOpen?: boolean;
     children: ReactNode;
 }>;
-export interface OverlayTriggerProps extends FlowComponentProps {
+export interface OverlayTriggerProps extends FlowComponentProps, PropsWithChildren {
+    /** Whether the overlay should be open initially. */
     isDefaultOpen?: boolean;
-    children: ReactNode;
+    /** A controller to control the state of the overlay. */
     controller?: OverlayController;
 }
 interface Props extends OverlayTriggerProps {

package/dist/js/types/components/Popover/Popover.d.ts

@@ -2,11 +2,18 @@ import { PropsWithChildren, default as React } from 'react';
 import { OverlayController } from '../../lib/controller';
 import * as Aria from "react-aria-components";
 export interface PopoverProps extends PropsWithChildren<Omit<Aria.PopoverProps, "children">> {
+    /**
+     * Whether the popover should display a tip, pointing towards the trigger
+     * element.
+     */
     withTip?: boolean;
+    /** Whether the popover contains a dialog. */
     isDialogContent?: boolean;
+    /** An overlay controller to control the popover state. */
     controller?: OverlayController;
+    /** A fixed width for the popover. */
     width?: string | number;
-    /** @default "m" */
+    /** The popovers padding. @default "m" */
     padding?: "s" | "m";
 }
 export declare const Popover: React.ForwardRefExoticComponent<PopoverProps & React.RefAttributes<never>>;

package/dist/js/types/components/ProgressBar/ProgressBar.d.ts

@@ -2,8 +2,9 @@ import { FC, PropsWithChildren } from 'react';
 import { PropsWithStatus } from '../../lib/types/props';
 import * as Aria from "react-aria-components";
 export interface ProgressBarProps extends PropsWithChildren<Omit<Aria.ProgressBarProps, "children">>, PropsWithStatus {
+    /** Whether the max value should be displayed. */
     showMaxValue?: boolean;
-    /** @default "m" */
+    /** The size variant of the progress bar @default "m" */
     size?: "s" | "m";
 }
 export declare const ProgressBar: FC<ProgressBarProps>;

package/dist/js/types/components/Select/Select.d.ts

@@ -6,7 +6,9 @@ import * as Aria from "react-aria-components";
 export interface SelectProps extends PropsWithChildren<Omit<Aria.SelectProps<{
     example: string;
 }>, "children" | "className">>, FlowComponentProps, PropsWithClassName {
+    /** Handler that is called when the selected value changes. */
     onChange?: (value: string | number) => void;
+    /** An overlay controller to control the select option popover state. */
     controller?: OverlayController;
 }
 export declare const Select: React.ForwardRefExoticComponent<SelectProps & React.RefAttributes<never>>;

package/dist/js/types/components/Skeleton/Skeleton.d.ts

@@ -1,6 +1,8 @@
 import { ComponentProps, FC } from 'react';
 export interface SkeletonProps extends ComponentProps<"div"> {
+    /** The width of the skeleton. */
     width?: string;
+    /** The height of the skeleton. */
     height?: string;
 }
 export declare const Skeleton: FC<SkeletonProps>;

package/dist/js/types/components/SkeletonText/SkeletonText.d.ts

@@ -1,5 +1,6 @@
 import { ComponentProps, FC } from 'react';
 export interface SkeletonTextProps extends ComponentProps<"div"> {
+    /** The width of the skeleton text. */
     width?: string;
 }
 export declare const SkeletonText: FC<SkeletonTextProps>;

package/dist/js/types/components/Switch/Switch.d.ts

@@ -2,7 +2,10 @@ import { PropsWithChildren, default as React } from 'react';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 import * as Aria from "react-aria-components";
 export interface SwitchProps extends PropsWithChildren<Omit<Aria.SwitchProps, "children">>, FlowComponentProps {
-    /** @default "trailing" */
+    /**
+     * Whether the label should appear before or after the switch. @default
+     * "trailing"
+     */
     labelPosition?: "leading" | "trailing";
 }
 export declare const Switch: React.ForwardRefExoticComponent<SwitchProps & React.RefAttributes<never>>;

package/dist/js/types/components/Table/Table.d.ts

@@ -1,6 +1,7 @@
 import { FC } from 'react';
 import * as Aria from "react-aria-components";
 export type TableProps = Aria.TableProps & {
+    /** The vertical alignment of the table cells content. */
     verticalAlign?: "top" | "middle";
 };
 export declare const Table: FC<TableProps>;

package/dist/js/types/components/TextArea/TextArea.d.ts

@@ -3,6 +3,10 @@ import { TextFieldBaseProps } from '../TextFieldBase';
 import { FlowComponentProps } from '../../lib/componentFactory/flowComponent';
 import * as Aria from "react-aria-components";
 export interface TextAreaProps extends Omit<TextFieldBaseProps, "input">, Pick<Aria.TextAreaProps, "placeholder" | "rows">, FlowComponentProps {
+    /**
+     * Whether the text area should grow if its content gets longer than its
+     * initial height.
+     */
     autoResizeMaxRows?: number;
 }
 export declare const TextArea: React.ForwardRefExoticComponent<TextAreaProps & React.RefAttributes<never>>;

package/dist/js/types/components/TextFieldBase/TextFieldBase.d.ts

@@ -1,7 +1,9 @@
 import { PropsWithChildren, ReactNode, default as React } from 'react';
 import * as Aria from "react-aria-components";
 export interface TextFieldBaseProps extends PropsWithChildren<Omit<Aria.TextFieldProps, "children">> {
+    /** The input element */
     input: ReactNode;
+    /** Whether a character count should be displayed inside the field description. */
     showCharacterCount?: boolean;
 }
 export declare const TextFieldBase: React.ForwardRefExoticComponent<TextFieldBaseProps & React.RefAttributes<HTMLInputElement>>;

package/dist/js/types/components/TimeField/TimeField.d.ts

@@ -1,6 +1,7 @@
 import { PropsWithChildren, ReactNode, default as React } from 'react';
 import * as Aria from "react-aria-components";
 export interface TimeFieldProps<T extends Aria.TimeValue> extends PropsWithChildren<Omit<Aria.TimeFieldProps<T>, "children">> {
+    /** An error message to be displayed below the field */
     errorMessage?: ReactNode;
 }
 export declare const TimeField: React.ForwardRefExoticComponent<TimeFieldProps<Aria.TimeValue> & React.RefAttributes<never>>;

package/dist/js/types/lib/types/props.d.ts

@@ -1,11 +1,13 @@
 import { ExoticComponent, HTMLAttributes, ReactHTML } from 'react';
 export type Status = "info" | "success" | "warning" | "danger";
 export type PropsWithStatus<T extends Status = Status, P = unknown> = P & {
+    /** The elements status */
     status?: T;
 };
 export interface PropsWithTunnel {
 }
 export interface PropsWithClassName {
+    /** The elements class name. */
     className?: string;
 }
 export type PropsWithElementType<T extends keyof ReactHTML = never> = HTMLAttributes<HTMLElement> & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/flow-react-components",
-  "version": "0.1.0-alpha.386",
+  "version": "0.1.0-alpha.387",
   "type": "module",
   "description": "A React implementation of Flow, mittwald’s design system",
   "homepage": "https://mittwald.github.io/flow",
@@ -425,7 +425,7 @@
     "@chakra-ui/live-region": "^2.1.0",
     "@internationalized/date": "^3.6.0",
     "@internationalized/string-compiler": "^3.2.6",
-    "@mittwald/react-tunnel": "^0.1.0-alpha.386",
+    "@mittwald/react-tunnel": "^0.1.0-alpha.387",
     "@mittwald/react-use-promise": "^2.6.0",
     "@react-aria/form": "^3.0.11",
     "@react-aria/utils": "^3.26.0",
@@ -456,7 +456,7 @@
   },
   "devDependencies": {
     "@faker-js/faker": "^9.2.0",
-    "@mittwald/flow-design-tokens": "^0.1.0-alpha.386",
+    "@mittwald/flow-design-tokens": "^0.1.0-alpha.387",
     "@mittwald/react-use-promise": "^2.6.0",
     "@nx/storybook": "^20.1.3",
     "@storybook/addon-a11y": "^8.4.5",
@@ -551,5 +551,5 @@
       }
     }
   },
-  "gitHead": "e8946b32b3d3df919b62b2a50bf4bae41e1d752c"
+  "gitHead": "4242fa57c7f347ac78a11b3b43dc9eced1e2b142"
 }