@qasa/qds-ui 0.1.0 → 0.1.2

package/dist/esm/types/components/stack/stack.d.ts

@@ -4,11 +4,37 @@ import type * as Polymorphic from '../../utils/polymorphic';
 import type { AlignItems, FlexDirection, JustifyContent, FlexWrap } from './stack.types';
 declare type GapProp = keyof Theme['spacing'];
 interface StackOptions {
+    /**
+     * The direction of the stack.
+     * @default 'column'
+     */
     direction?: FlexDirection;
+    /**
+     * The CSS `justify-content` property.
+     * Controls the alignment of items on the main axis.
+     */
     justifyContent?: JustifyContent;
+    /**
+     * The CSS `align-items` property.
+     * Controls the alignment of items on the cross axis.
+     */
     alignItems?: AlignItems;
+    /**
+     * The CSS `flex-wrap` property.
+     * Controls whether children can wrap onto multiple lines.
+     * @default 'nowrap'
+     */
     wrap?: FlexWrap;
+    /**
+     * The gap between each child element.
+     */
     gap?: GapProp;
+    /**
+     * A divider element to be rendered between each child element.
+     *
+     * _Note: For the divider to be rendered, the child elements can't be loose strings or numbers.
+     *  Wrap them in a `div` or other element._
+     */
     divider?: ReactNode;
 }
 declare type StackComponent = Polymorphic.ForwardRefComponent<'div', StackOptions>;

package/dist/esm/types/hooks/use-form-field.d.ts

@@ -29,9 +29,9 @@ interface FormFieldOptions {
     isRequired?: boolean;
 }
 declare type OmittedProps = 'children' | 'readOnly' | 'size';
-declare type UseFormFieldProps<T extends FormFieldElement> = Omit<HTMLQdsProps<T>, OmittedProps> & FormFieldOptions;
+export declare type UseFormFieldProps<T extends FormFieldElement> = Omit<HTMLQdsProps<T>, OmittedProps> & FormFieldOptions;
 /**
- * Custom hook that returns props for a form field's label, inpu, helper text and error message.
+ * Custom hook that returns props for a form field's label, input, helper text and error message.
  * Meant to be used in conjunction with the `Input`, `Select` or `Textarea` component.
  *
  * Used internally by `TextField`, `Select` and `Textarea`.

package/dist/index.d.ts

@@ -4844,11 +4844,37 @@ declare type FlexWrap = 'wrap' | 'nowrap' | 'wrap-reverse';
 
 declare type GapProp = keyof Theme['spacing'];
 interface StackOptions {
+    /**
+     * The direction of the stack.
+     * @default 'column'
+     */
     direction?: FlexDirection;
+    /**
+     * The CSS `justify-content` property.
+     * Controls the alignment of items on the main axis.
+     */
     justifyContent?: JustifyContent;
+    /**
+     * The CSS `align-items` property.
+     * Controls the alignment of items on the cross axis.
+     */
     alignItems?: AlignItems;
+    /**
+     * The CSS `flex-wrap` property.
+     * Controls whether children can wrap onto multiple lines.
+     * @default 'nowrap'
+     */
     wrap?: FlexWrap;
+    /**
+     * The gap between each child element.
+     */
     gap?: GapProp;
+    /**
+     * A divider element to be rendered between each child element.
+     *
+     * _Note: For the divider to be rendered, the child elements can't be loose strings or numbers.
+     *  Wrap them in a `div` or other element._
+     */
     divider?: ReactNode;
 }
 declare type StackComponent = ForwardRefComponent<'div', StackOptions>;
@@ -4945,7 +4971,7 @@ interface FormFieldOptions {
 declare type OmittedProps = 'children' | 'readOnly' | 'size';
 declare type UseFormFieldProps<T extends FormFieldElement> = Omit<HTMLQdsProps<T>, OmittedProps> & FormFieldOptions;
 /**
- * Custom hook that returns props for a form field's label, inpu, helper text and error message.
+ * Custom hook that returns props for a form field's label, input, helper text and error message.
  * Meant to be used in conjunction with the `Input`, `Select` or `Textarea` component.
  *
  * Used internally by `TextField`, `Select` and `Textarea`.
@@ -4975,4 +5001,4 @@ declare function useStableId(fixedId?: string | null): string;
  */
 declare const useSafeLayoutEffect: typeof useLayoutEffect;
 
-export { ArrowDownIcon, ArrowLeftIcon, ArrowRightIcon, ArrowUpIcon, Avatar, AvatarProps, BellIcon, BellSlashIcon, Button, ButtonProps, CalendarIcon, CheckIcon, ChevronDownIcon, ChevronLeftIcon, ChevronRightIcon, ChevronUpIcon, CreateIconOptions, Divider, DividerProps, EllipsisIcon, EllipsisVerticalIcon, ForwardRefComponent, GlobalStyles, Heading, HeadingProps, HeartFilledIcon, HeartIcon, IconButton, IconButtonProps, IconProps, Image, ImageIcon, ImageProps, InputBase, InputBaseOptions, InputBaseProps, IntrinsicElement, Label, LabelProps, Link, LinkProps, LoadingDots, LoadingDotsProps, LocationDotIcon, MapIcon, OwnProps, Paragraph, ParagraphProps, PlusIcon, PropsOf, QdsProvider, SearchIcon, Select, SelectBase, SelectBaseOptions, SelectOptionProps, SelectProps, SettingsIcon, Spacer, SpacerProps, Stack, StackProps, StarFilledIcon, StarIcon, TextField, TextFieldProps, Textarea, TextareaBase, TextareaBaseOptions, TextareaBaseProps, TextareaProps, Theme, ThemeOverrides, TrashIcon, UseBreakpointOptions, UseBreakpointValueProps, UseImageProps, UserIcon, VariantProps, XmarkIcon, createIcon, createStyle, createStyleVariants, getFormFieldBaseStyles, overrideTheme, pxToRem, theme, useBreakpoint, useBreakpointValue, useFormField, useImage, useSafeLayoutEffect, useStableId };
+export { ArrowDownIcon, ArrowLeftIcon, ArrowRightIcon, ArrowUpIcon, Avatar, AvatarProps, BellIcon, BellSlashIcon, Button, ButtonProps, CalendarIcon, CheckIcon, ChevronDownIcon, ChevronLeftIcon, ChevronRightIcon, ChevronUpIcon, CreateIconOptions, Divider, DividerProps, EllipsisIcon, EllipsisVerticalIcon, ForwardRefComponent, GlobalStyles, Heading, HeadingProps, HeartFilledIcon, HeartIcon, IconButton, IconButtonProps, IconProps, Image, ImageIcon, ImageProps, InputBase, InputBaseOptions, InputBaseProps, IntrinsicElement, Label, LabelProps, Link, LinkProps, LoadingDots, LoadingDotsProps, LocationDotIcon, MapIcon, OwnProps, Paragraph, ParagraphProps, PlusIcon, PropsOf, QdsProvider, SearchIcon, Select, SelectBase, SelectBaseOptions, SelectOptionProps, SelectProps, SettingsIcon, Spacer, SpacerProps, Stack, StackProps, StarFilledIcon, StarIcon, TextField, TextFieldProps, Textarea, TextareaBase, TextareaBaseOptions, TextareaBaseProps, TextareaProps, Theme, ThemeOverrides, TrashIcon, UseBreakpointOptions, UseBreakpointValueProps, UseFormFieldProps, UseImageProps, UserIcon, VariantProps, XmarkIcon, createIcon, createStyle, createStyleVariants, getFormFieldBaseStyles, overrideTheme, pxToRem, theme, useBreakpoint, useBreakpointValue, useFormField, useImage, useSafeLayoutEffect, useStableId };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qasa/qds-ui",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "license": "UNLICENSED",
   "publishConfig": {
     "access": "public"