Skip to content

Commit

Permalink
docs(show-hide): adding props descriptions to Show / Hide components
Browse files Browse the repository at this point in the history
  • Loading branch information
nikolovlazar committed Feb 14, 2022
1 parent c5eb9c0 commit eca771a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changeset/breezy-dogs-sniff.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@chakra-ui/media-query": patch
---

Added props descriptions to Show / Hide components
9 changes: 9 additions & 0 deletions packages/media-query/src/media-query.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,17 @@ 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. Similar to `max-width`. 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. Similar to `min-width`. Default breakpoint values: `sm`, `md`, `lg`, `xl`, `2xl`.
*/
above?: string
children?: React.ReactNode
}
Expand Down

0 comments on commit eca771a

Please sign in to comment.