Merge pull request #5574 from chakra-ui/docs/show-hide-props

docs(show-hide): adding props descriptions to Show / Hide components
chakra-ui · Feb 14, 2022 · d24f935 · d24f935 · vercel · Feb 14, 2022
2 parents c5eb9c0 + 5b27957
commit d24f935
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.changeset/breezy-dogs-sniff.md b/.changeset/breezy-dogs-sniff.md
@@ -0,0 +1,5 @@
+---
+"@chakra-ui/media-query": patch
+---
+
+Added props descriptions to Show / Hide components
diff --git a/packages/media-query/src/media-query.tsx b/packages/media-query/src/media-query.tsx
@@ -41,8 +41,20 @@ if (__DEV__) {
 }
 
 export interface ShowProps {
+  /**
+   * A custom css media query that determines when the `children` are rendered.
+   * Will render `children` if that query resolves to `true`.
+   */
   breakpoint?: string
+  /**
+   * A value from the `breakpoints` section in the theme. Will render `children`
+   * from that breakpoint and below. Default breakpoint values: `sm`, `md`, `lg`, `xl`, `2xl`.
+   */
   below?: string
+  /**
+   * A value from the `breakpoints` section in the theme. Will render `children`
+   * from that breakpoint and above. Default breakpoint values: `sm`, `md`, `lg`, `xl`, `2xl`.
+   */
   above?: string
   children?: React.ReactNode
 }