From 9c0b6deda91852fc5d33f2cb078acf5a4b093315 Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Thu, 5 Jul 2018 18:44:01 -0400 Subject: [PATCH] docs(show-hide-when): update generated readme files --- core/src/components/hide-when/readme.md | 42 +++++++++++++++++++++++++ core/src/components/show-when/readme.md | 42 +++++++++++++++++++++++++ 2 files changed, 84 insertions(+) diff --git a/core/src/components/hide-when/readme.md b/core/src/components/hide-when/readme.md index 6a9e222070..507b50aed5 100644 --- a/core/src/components/hide-when/readme.md +++ b/core/src/components/hide-when/readme.md @@ -12,26 +12,47 @@ string +If the current media query matches this value, the element will hide. + + +#### mode + +string + +If the current platform matches the given value, the element will hide. +Accepts a comma separated list of modes to match against. + #### or boolean +If false, and two or more conditions are set, the element will hide when all are true. +If true, and two or more conditions are set, the element will hide when at least one is true. + #### orientation string +If the current orientation matches this value, the element will hide. + #### platform string +If the current platform matches the given value, the element will hide. +Accepts a comma separated list of platform to match against. + #### size string +If the current screen width matches the given size, the element will hide. +Uses the build in sizes of xs, sm, md, lg, xl. + ## Attributes @@ -39,26 +60,47 @@ string string +If the current media query matches this value, the element will hide. + + +#### mode + +string + +If the current platform matches the given value, the element will hide. +Accepts a comma separated list of modes to match against. + #### or boolean +If false, and two or more conditions are set, the element will hide when all are true. +If true, and two or more conditions are set, the element will hide when at least one is true. + #### orientation string +If the current orientation matches this value, the element will hide. + #### platform string +If the current platform matches the given value, the element will hide. +Accepts a comma separated list of platform to match against. + #### size string +If the current screen width matches the given size, the element will hide. +Uses the build in sizes of xs, sm, md, lg, xl. + ---------------------------------------------- diff --git a/core/src/components/show-when/readme.md b/core/src/components/show-when/readme.md index 37d84d37bf..a7330a9769 100644 --- a/core/src/components/show-when/readme.md +++ b/core/src/components/show-when/readme.md @@ -13,26 +13,47 @@ ShowWhen can watch for platform changes, mode changes, css media queries, and de string +If the current media query matches this value, the element will show. + + +#### mode + +string + +If the current platform matches the given value, the element will show. +Accepts a comma separated list of modes to match against. + #### or boolean +If false, and two or more conditions are set, the element will show when all are true. +If true, and two or more conditions are set, the element will show when at least one is true. + #### orientation string +If the current orientation matches this value, the element will show. + #### platform string +If the current platform matches the given value, the element will show. +Accepts a comma separated list of platform to match against. + #### size string +If the current screen width matches the given size, the element will show. +Uses the build in sizes of xs, sm, md, lg, xl. + ## Attributes @@ -40,26 +61,47 @@ string string +If the current media query matches this value, the element will show. + + +#### mode + +string + +If the current platform matches the given value, the element will show. +Accepts a comma separated list of modes to match against. + #### or boolean +If false, and two or more conditions are set, the element will show when all are true. +If true, and two or more conditions are set, the element will show when at least one is true. + #### orientation string +If the current orientation matches this value, the element will show. + #### platform string +If the current platform matches the given value, the element will show. +Accepts a comma separated list of platform to match against. + #### size string +If the current screen width matches the given size, the element will show. +Uses the build in sizes of xs, sm, md, lg, xl. + ----------------------------------------------