docs(show-hide-when): update generated readme files

This commit is contained in:
Brandy Carney
2018-07-05 18:44:01 -04:00
parent c1a514d224
commit 9c0b6deda9
2 changed files with 84 additions and 0 deletions

View File

@ -12,26 +12,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 #### or
boolean 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 #### orientation
string string
If the current orientation matches this value, the element will hide.
#### platform #### platform
string string
If the current platform matches the given value, the element will hide.
Accepts a comma separated list of platform to match against.
#### size #### size
string 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 ## Attributes
@ -39,26 +60,47 @@ string
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 #### or
boolean 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 #### orientation
string string
If the current orientation matches this value, the element will hide.
#### platform #### platform
string string
If the current platform matches the given value, the element will hide.
Accepts a comma separated list of platform to match against.
#### size #### size
string 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.
---------------------------------------------- ----------------------------------------------

View File

@ -13,26 +13,47 @@ ShowWhen can watch for platform changes, mode changes, css media queries, and de
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 #### or
boolean 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 #### orientation
string string
If the current orientation matches this value, the element will show.
#### platform #### platform
string string
If the current platform matches the given value, the element will show.
Accepts a comma separated list of platform to match against.
#### size #### size
string 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 ## Attributes
@ -40,26 +61,47 @@ string
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 #### or
boolean 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 #### orientation
string string
If the current orientation matches this value, the element will show.
#### platform #### platform
string string
If the current platform matches the given value, the element will show.
Accepts a comma separated list of platform to match against.
#### size #### size
string 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.
---------------------------------------------- ----------------------------------------------