This repository has been archived by the owner on Nov 9, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move visibility readme to doc folder and sym link for template README…
….md [#125]
- Loading branch information
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Base/Block | ||
|
||
## Definition | ||
|
||
This library provides several helper utilities related to visibility. The | ||
classes described in this module may be applied to any element and define | ||
visibility unless the element is already hidden by a parent element. | ||
|
||
## Usages | ||
|
||
The `Base/Visibility/Hide` library provides a helper that sets visibility to | ||
none for all devices. This is useful in the context of Javascript by adding and | ||
removing this class to change visibility. An alternative might be using the | ||
`display:none` property such as in jQuery. | ||
|
||
The `Base/Visibility/Responsive/Show` library provides helpers that set visibility | ||
to none for devices with viewport dimensions that **do** meet the breakpoints | ||
specified as `$base-breakpoint-small` and `$base-breakpoint-medium`. | ||
|
||
The `Base/Visibility/Responsive/Show` library provides helpers that set visibility | ||
to none for devices with viewport dimensions that **don't** meet the breakpoints | ||
specified as `$base-breakpoint-small` and `$base-breakpoint-medium`. | ||
|
||
## Features | ||
|
||
### Base/Visibility/Hide | ||
|
||
* `.hide` applies left-alignment to text | ||
|
||
### Base/Visibility/Responsive/Hide | ||
|
||
* `.hide-small` hides the element on all devices smaller than `$base-breakpoint-small` | ||
* `.hide-medium` hides the element on all devices smaller than `$base-breakpoint-medium` and at least as large as `$base-breakpoint-small` | ||
* `.hide-large` hides the element on all devices at least as large as `$base-breakpoint-medium` | ||
|
||
### Base/Visibility/Responsive/Show | ||
|
||
* `.show-small` shows the element on all devices smaller than `$base-breakpoint-small` | ||
* `.show-medium` shows the element on all devices smaller than `$base-breakpoint-medium` and at least as large as `$base-breakpoint-small` | ||
* `.show-large` shows the element on all devices at least as large as `$base-breakpoint-medium` | ||
|
||
## Responsive Considerations | ||
|
||
All visibility classes in `Base/Visibility/Responsive` relate visibility of an | ||
element to |