chore(ui): Update API reference

contember · Jul 1, 2023 · 407c53f · 407c53f
1 parent af92562
commit 407c53f
Showing 1 changed file with 22 additions and 13 deletions.
diff --git a/build/api/ui.api.md b/build/api/ui.api.md
@@ -165,8 +165,12 @@ export interface BoxOwnProps {
     // (undocumented)
     distinction?: BoxDistinction;
     // (undocumented)
+    footer?: ReactNode;
+    // (undocumented)
     gap?: Size | 'none';
     // (undocumented)
+    header?: ReactNode;
+    // @deprecated (undocumented)
     heading?: ReactNode;
     // (undocumented)
     intent?: Intent;
@@ -619,20 +623,22 @@ export interface DialogProviderProps {
 }
 
 // @public (undocumented)
-export interface DialogSettings<Result> {
-    // (undocumented)
-    bare?: boolean;
-    // (undocumented)
-    container?: HTMLElement;
-    // (undocumented)
+export type DialogSettings<Result> = ({
+    type?: Default | 'immersive' | 'captivating';
+    children?: ReactNode | ((resolve: ResolveCallback<Result>) => ReactElement);
+    content?: never;
+    container?: never;
+    bare?: never;
+    heading?: never;
+    gap?: never;
+} | {
     content: (props: RenderDialogContentProps<Result>) => ReactElement;
-    // (undocumented)
-    gap?: BoxProps['gap'];
-    // (undocumented)
-    heading?: ReactNode;
-    // (undocumented)
+    container?: HTMLElement;
     type?: Default | 'immersive' | 'captivating';
-}
+    bare?: boolean;
+    heading?: ReactNode;
+    gap?: BoxProps['gap'];
+});
 
 // @public (undocumented)
 export function DimensionSwitcher({ dimensions }: DimensionSwitcherProps): JSX.Element;
@@ -2153,7 +2159,7 @@ withTopToolbar?: boolean | undefined;
 // @public (undocumented)
 export type RangeInputProps = TextInputProps;
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export interface RenderDialogContentProps<Result> {
     // (undocumented)
     resolve: (value?: Result) => void;
@@ -2186,6 +2192,9 @@ export interface RepeaterItemContainerProps {
     label?: ReactNode;
 }
 
+// @public (undocumented)
+export type ResolveCallback<Result> = (value?: Result) => void;
+
 // @public (undocumented)
 export interface RestHTMLCheckboxProps extends Omit<AllHTMLAttributes<HTMLInputElement>, ControlPropsKeys<boolean> | 'checked' | 'children'> {
 }