@qasa/qds-ui 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,11 +4,37 @@ import type * as Polymorphic from '../../utils/polymorphic';
4
4
  import type { AlignItems, FlexDirection, JustifyContent, FlexWrap } from './stack.types';
5
5
  declare type GapProp = keyof Theme['spacing'];
6
6
  interface StackOptions {
7
+ /**
8
+ * The direction of the stack.
9
+ * @default 'column'
10
+ */
7
11
  direction?: FlexDirection;
12
+ /**
13
+ * The CSS `justify-content` property.
14
+ * Controls the alignment of items on the main axis.
15
+ */
8
16
  justifyContent?: JustifyContent;
17
+ /**
18
+ * The CSS `align-items` property.
19
+ * Controls the alignment of items on the cross axis.
20
+ */
9
21
  alignItems?: AlignItems;
22
+ /**
23
+ * The CSS `flex-wrap` property.
24
+ * Controls whether children can wrap onto multiple lines.
25
+ * @default 'nowrap'
26
+ */
10
27
  wrap?: FlexWrap;
28
+ /**
29
+ * The gap between each child element.
30
+ */
11
31
  gap?: GapProp;
32
+ /**
33
+ * A divider element to be rendered between each child element.
34
+ *
35
+ * _Note: For the divider to be rendered, the child elements can't be loose strings or numbers.
36
+ * Wrap them in a `div` or other element._
37
+ */
12
38
  divider?: ReactNode;
13
39
  }
14
40
  declare type StackComponent = Polymorphic.ForwardRefComponent<'div', StackOptions>;
@@ -12,5 +12,5 @@ export declare type UseBreakpointValueProps<T> = BreakpointsConfig<T>;
12
12
  * @example
13
13
  * const width = useBreakpointValue({ base: '150px', md: '250px' })
14
14
  */
15
- export declare function useBreakpointValue<T>(values: UseBreakpointValueProps<T>, options?: UseBreakpointOptions): T | undefined;
15
+ export declare function useBreakpointValue<T>(values: UseBreakpointValueProps<T>, options?: UseBreakpointOptions): T;
16
16
  export {};
package/dist/index.d.ts CHANGED
@@ -4844,11 +4844,37 @@ declare type FlexWrap = 'wrap' | 'nowrap' | 'wrap-reverse';
4844
4844
 
4845
4845
  declare type GapProp = keyof Theme['spacing'];
4846
4846
  interface StackOptions {
4847
+ /**
4848
+ * The direction of the stack.
4849
+ * @default 'column'
4850
+ */
4847
4851
  direction?: FlexDirection;
4852
+ /**
4853
+ * The CSS `justify-content` property.
4854
+ * Controls the alignment of items on the main axis.
4855
+ */
4848
4856
  justifyContent?: JustifyContent;
4857
+ /**
4858
+ * The CSS `align-items` property.
4859
+ * Controls the alignment of items on the cross axis.
4860
+ */
4849
4861
  alignItems?: AlignItems;
4862
+ /**
4863
+ * The CSS `flex-wrap` property.
4864
+ * Controls whether children can wrap onto multiple lines.
4865
+ * @default 'nowrap'
4866
+ */
4850
4867
  wrap?: FlexWrap;
4868
+ /**
4869
+ * The gap between each child element.
4870
+ */
4851
4871
  gap?: GapProp;
4872
+ /**
4873
+ * A divider element to be rendered between each child element.
4874
+ *
4875
+ * _Note: For the divider to be rendered, the child elements can't be loose strings or numbers.
4876
+ * Wrap them in a `div` or other element._
4877
+ */
4852
4878
  divider?: ReactNode;
4853
4879
  }
4854
4880
  declare type StackComponent = ForwardRefComponent<'div', StackOptions>;
@@ -4903,7 +4929,7 @@ declare type UseBreakpointValueProps<T> = BreakpointsConfig<T>;
4903
4929
  * @example
4904
4930
  * const width = useBreakpointValue({ base: '150px', md: '250px' })
4905
4931
  */
4906
- declare function useBreakpointValue<T>(values: UseBreakpointValueProps<T>, options?: UseBreakpointOptions): T | undefined;
4932
+ declare function useBreakpointValue<T>(values: UseBreakpointValueProps<T>, options?: UseBreakpointOptions): T;
4907
4933
 
4908
4934
  declare type LoadingStatus = 'loading' | 'loaded' | 'error' | 'pending';
4909
4935
  interface UseImageProps {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qasa/qds-ui",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "license": "UNLICENSED",
5
5
  "publishConfig": {
6
6
  "access": "public"