From eca771a9ad53edc52365f70eb0e6b19bc54d8e18 Mon Sep 17 00:00:00 2001 From: Lazar Nikolov Date: Mon, 14 Feb 2022 08:12:26 +0100 Subject: [PATCH] docs(show-hide): adding props descriptions to Show / Hide components --- .changeset/breezy-dogs-sniff.md | 5 +++++ packages/media-query/src/media-query.tsx | 9 +++++++++ 2 files changed, 14 insertions(+) create mode 100644 .changeset/breezy-dogs-sniff.md diff --git a/.changeset/breezy-dogs-sniff.md b/.changeset/breezy-dogs-sniff.md new file mode 100644 index 00000000000..1e1e020d37d --- /dev/null +++ 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 index 80458cf4148..31db310f80e 100644 --- a/packages/media-query/src/media-query.tsx +++ b/packages/media-query/src/media-query.tsx @@ -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 }