feat(preview): add ts type definitions

Sage · May 11, 2021 · b653c65 · b653c65
1 parent c769de8
commit b653c65
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/components/preview/index.d.ts b/src/components/preview/index.d.ts
@@ -0,0 +1 @@
+export { default } from "./preview";
diff --git a/src/components/preview/preview.d.ts b/src/components/preview/preview.d.ts
@@ -1,14 +1,17 @@
 import * as React from "react";
-import { MarginSpacingProps } from "../../utils/helpers/options-helper";
+import { MarginProps } from "styled-system";
 
-export interface PreviewProps extends MarginSpacingProps {
-  children?: React.ReactNode;
+export interface PreviewProps extends MarginProps {
+  /** A custom height to be applied to the component. */
   height?: string;
+  /** The number of lines to render. */
   lines?: number;
+  /* Provides more control over when in a loading state. */
   loading?: boolean;
+  /** A custom width */
   width?: string;
 }
 
-declare const Preview: React.FunctionComponent<PreviewProps>;
+declare function Preview(props: React.PropsWithChildren<PreviewProps>): JSX.Element;
 
 export default Preview;