--- layout: default title: Components · Ratchet ---

Ratchet

Components

Design patterns that serve as basic building blocks

Base iOS Android

Title

Title bar

Title bars are full width and docked to the top of the viewport.

Title

{% highlight html %}

Title

{% endhighlight %}

Title bar with buttons

Buttons in a title bar are left or right aligned and should be used for actions.

Left Right

Title

{% highlight html %}
Left Right

Title

{% endhighlight %}

Title bar with icons

Title

{% highlight html %}

Title

{% endhighlight %}

Title bar with link buttons and icons

Buttons in a title bar are left or right aligned and should be used for actions.

Left Right

Title

{% highlight html %}
Left Right

Title

{% endhighlight %}

Title bar with segmented control

Title bars can also house segmented controls. Feel free to add accompanying buttons too. The control will automatically layout itself out correctly.

Left Right
One Two Three
{% highlight html %}
Left Right
One Two Three
{% endhighlight %}

Typography

Use headings and paragraphs to title and describe sections of your app.

h1. Heading

h2. Heading

h3. Heading

h4. Heading

h5. Heading
h6. Heading

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco.

{% highlight html %}

h1. Heading

h2. Heading

h3. Heading

h4. Heading

h5. Heading
h6. Heading

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco.

{% endhighlight %}

Table views

Table views can be used for organizing data, showing collections of links or a series of controls.

  • Item 1
  • Item 2
  • Divider
  • Item 3
{% highlight html %}
  • Item 1
  • Item 2
  • Divider
  • Item 3
{% endhighlight %}

Table view with badges

  • Item 1 4
  • Item 2 1
  • Item 3 5
{% highlight html %}
  • Item 1 4
  • Item 2 1
  • Item 3 5
{% endhighlight %}

Table view with media (images)

{% highlight html %} {% endhighlight %}

Table view with toggles

  • Item 1
  • Item 2
  • Item 3
{% highlight html %}
  • Item 1
  • Item 2
  • Item 3
{% endhighlight %}

Carded table views

  • Item 1
  • Item 2
  • Divider
  • Item 3
  • Item 4
{% highlight html %}
  • Item 1
  • Item 2
  • Divider
  • Item 3
  • Item 4
{% endhighlight %}

Segmented control

Created with flex-box so button sizes and spacing are consistent. Content sections that are to be swapped in and out by the controller should all be siblings and have the class "control-content". Then, just give each content section an id and point the link in the segmented control to that id.

Thing one Thing two Thing three
Item 1 Item 2 Item 3
{% highlight html %}
Thing one Thing two Thing three
Item 1 Item 2 Item 3
{% endhighlight %}

Badges

Badges come in four flavors and should be used to indicate "how many" of something there are.

1 2 3 4 1 2 3 4
{% highlight html %} 1 2 3 4 1 2 3 4 {% endhighlight %}

Form with input group

{% highlight html %}
{% endhighlight %}

Form with input group and labels

{% highlight html %}
{% endhighlight %}

Toggles

Toggles can be used by sliding or tapping the control.

{% highlight html %}
{% endhighlight %}

Toggles.js binds an event to the document that returns a detail object and can be used to fire a callback.

{% highlight js %} // Only needed if you want to fire a callback document .querySelector('#myToggle') .addEventListener('toggle', myFunction) {% endhighlight %}

Popovers

Popover title

  • Item1
  • Item2
  • Item3
  • Item4
  • Item5
  • Item6
  • Item7
  • Item8
{% highlight html %}

Popover title

  • Item1
  • Item2
  • Item3
  • Item4
  • Item5
  • Item6
  • Item7
  • Item8
{% endhighlight %}

Popovers are designed to only fire from title bars. Set the value of the title href to the id of a popover, like so:

{% highlight html %}

Tap title

{% endhighlight %}

Modals

Open modal
{% highlight html %} Open modal {% endhighlight %}

Modals are designed to only fire from links. Set the value of the toggle links href to the id of a modal.

Sliders

Can be used with any number of slides with any type of content.

Slide me
{% highlight html %}
Slide me
{% endhighlight %}

Sliders.js binds an event to the document that returns a detail object and can be used to fire a callback.

{% highlight js %} // Only needed if you want to fire a callback document .querySelector('#mySlider') .addEventListener('slide', myFunction) {% endhighlight %}

Push

Push.js is the engine that connects Ratchet pages together with AJAX and the history api. Push.js is listening to all clicks on a page, so just make sure it's included and link something in your Ratchet project up.

{% highlight html %} Two {% endhighlight %}

This will use push to replace everything in the .content div with the .content of two.html. Also, it will either update or remove .bar-nav and .bar-tab according to their presences in two.html.

Now that pages are being loaded through push, it's easy to specify transitions for animations between pages. There are three different transitions to chose from: fade, slide-in, or slide-out.

{% highlight html %} Two {% endhighlight %}

A working version of push:

Push

{% highlight html %}

Push

{% endhighlight %}

Have a link you don't want to intercepted by push? Try this:

{% highlight html %} Google {% endhighlight %}

Push.js binds an event to the document that returns a detail object and can be used to fire a callback.

{% highlight js %} // Only needed if you want to fire a callback window.addEventListener('push', myFunction); {% endhighlight %}
{% include footer.html %}