Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds intermediate usage examples to README #324

Merged
merged 4 commits into from
May 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 33 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,36 +89,64 @@ Here are some shortcuts for quick access:

## Examples

> Although the examples below use `atomic-layout` package, they are fully compliant with other styling implementations (i.e. `@atomic-layout/emotion`).
> Although the examples below use `atomic-layout` package, they are fully compatible with other styling implementations of the library (i.e. `@atomic-layout/emotion`).

### Basics

<table border="0">
<tr>
<td width="33%" valign="top">
<a href="https://codesandbox.io/s/basic-composition-5mvlr" target="_blank">
<img src="materials/example-thumbnails/basic-composition.jpg#" alt="Basic composition: square and circle" />
<img src="materials/example-thumbnails/basic-composition.jpg" alt="Basic composition: square and circle" />
<h4>Basic composition</h4>
</a>
<p>Combine two UI elements into a single one using Composition.</p>
</td>
<td width="33%" valign="top">
<a href="https://codesandbox.io/s/responsive-props-8m14f" target="_blank">
<img src="materials/example-thumbnails/responsive-props.jpg#" alt="Component with responsive props" />
<img src="materials/example-thumbnails/responsive-props.jpg" alt="Component with responsive props" />
<h4>Responsive props</h4>
</a>
<p>Learn how to change a prop's value depending on a breakpoint.</p>
<p>Change a prop's value depending on a breakpoint.</p>
</td>
<td width="33%" valign="top">
<a href="https://codesandbox.io/s/nested-composition-8p8pk" target="_blank">
<img src="materials/example-thumbnails/nested-composition.jpg#" alt="Composition of other compositions" />
<img src="materials/example-thumbnails/nested-composition.jpg" alt="Composition of other compositions" />
<h4>Nested composition</h4>
</a>
<p>Any element can be a composition <i>and</i> a composite at the same time.</p>
</td>
</tr>
</table>

### Intermediate

<table border="0">
<tr>
<td width="33%" valign="top">
<a href="https://codesandbox.io/s/conditional-rendering-4k90o" target="_blank">
<img src="materials/example-thumbnails/conditional-rendering.jpg" alt="Conditional rendering" />
<h4>Conditional rendering</h4>
</a>
<p>Render or display elements conditionally based on breakpoints.</p>
</td>
<td width="33%" valign="top">
<a href="https://codesandbox.io/s/custom-configuration-d01ku" target="_blank">
<img src="materials/example-thumbnails/custom-configuration.jpg" alt="Custom configuration" />
<h4>Custom configuration</h4>
</a>
<p>Configure a default measurement unit, custom breakpoints, and responsive behaviors.</p>
</td>
<td width="33%" valign="top">
<a href="https://codesandbox.io/s/atomic-layout-query-d2mdl" target="_blank">
<img src="materials/example-thumbnails/shorthand-media-query.jpg" alt="Shorthand media query" />
<h4>Shorthand media query</h4>
</a>
<p>Use a shorthand <code>query</code> function to declare inline media queries in CSS.</p>
</td>
</tr>
</table>

## Materials

<table border="0">
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.