├── .gitignore ├── LICENSE ├── README.md ├── _config.yml ├── _includes ├── badge.html ├── breadcrumbs.html ├── card.html ├── component-code-tabs.html ├── component-example.html ├── definition-list-fine-print.html ├── definition-list.html ├── footer.html ├── head.html ├── header.html ├── icons.html ├── iframe.html ├── link-list.html ├── logo.html ├── page-header.html ├── patterns │ ├── 01-molecules-02-blocks-card │ │ ├── 01-molecules-02-blocks-card.markup-only.html │ │ ├── 01-molecules-02-blocks-card.mustache │ │ └── 01-molecules-02-blocks-card.rendered.html │ ├── 01-molecules-02-blocks-hero-blue-tint │ │ ├── 01-molecules-02-blocks-hero-blue-tint.markup-only.html │ │ ├── 01-molecules-02-blocks-hero-blue-tint.mustache │ │ └── 01-molecules-02-blocks-hero-blue-tint.rendered.html │ ├── 01-molecules-02-blocks-hero-red-tint │ │ ├── 01-molecules-02-blocks-hero-red-tint.markup-only.html │ │ ├── 01-molecules-02-blocks-hero-red-tint.mustache │ │ └── 01-molecules-02-blocks-hero-red-tint.rendered.html │ └── 01-molecules-02-blocks-hero │ │ ├── 01-molecules-02-blocks-hero.markup-only.html │ │ ├── 01-molecules-02-blocks-hero.mustache │ │ └── 01-molecules-02-blocks-hero.rendered.html ├── primary-nav-item.html ├── primary-nav-submenu.html ├── primary-nav.html └── stacked-block-list.html ├── _layouts ├── component-category.html ├── component-detail.html ├── component-viewall.html ├── default.html ├── landing.html ├── page.html └── post.html ├── _posts ├── 2017-05-13-initial-release.md └── 2017-05-14-v1.md ├── _sass ├── abstracts │ ├── _mixins.scss │ └── _variables.scss ├── base │ ├── _body.scss │ ├── _buttons.scss │ ├── _forms.scss │ ├── _headings.scss │ ├── _links.scss │ ├── _lists.scss │ ├── _main.scss │ ├── _media.scss │ ├── _reset.scss │ ├── _tables.scss │ └── _text.scss ├── components │ ├── _banner.scss │ ├── _block.scss │ ├── _breadcrumbs.scss │ ├── _button-group.scss │ ├── _buttons.scss │ ├── _card.scss │ ├── _footer-nav.scss │ ├── _footer.scss │ ├── _grid-nav.scss │ ├── _header.scss │ ├── _hero.scss │ ├── _icon.scss │ ├── _logo.scss │ ├── _nav.scss │ ├── _page-header.scss │ ├── _primary-nav.scss │ ├── _section.scss │ ├── _table.scss │ ├── _tabs.scss │ ├── _text-passage.scss │ └── _tile.scss ├── layout │ └── _layout.scss └── utilities │ ├── _display.scss │ └── _visibility.scss ├── about.html ├── components ├── 01-index.md ├── blocks-and-cards │ ├── card.md │ ├── hero.md │ ├── index.md │ └── tile.md ├── buttons │ ├── button-group.md │ ├── button.md │ ├── index.md │ └── text-button.md ├── charts-and-graphs │ ├── bar-graph.md │ └── index.md ├── form-controls │ ├── index.md │ └── text-field.md ├── headers-and-footers │ ├── footer.md │ ├── horizontal-header.md │ ├── index.md │ └── vertical-header.md ├── icons │ ├── icons.md │ └── index.md ├── interactive │ ├── index.md │ └── tabs.md ├── lists-and-collections │ ├── card-list.md │ ├── index.md │ └── tile-list.md ├── media │ ├── index.md │ └── video.md ├── messaging │ ├── alert.md │ ├── index.md │ └── tooltip.md ├── navigation │ ├── breadcrumbs.md │ └── index.md ├── tables │ ├── index.md │ └── table.md ├── text │ ├── index.md │ ├── page-header.md │ ├── section-header.md │ └── text-passage.md └── view-all.html ├── contribute.html ├── css ├── main.scss └── style-guide.scss ├── downloads.md ├── favicon.ico ├── feed.xml ├── gallery.html ├── getting-started.html ├── guidelines ├── 01-index.md ├── 02-principles.md ├── 03-code.md ├── 04-accessibility.md ├── 05-data-display.md ├── 06-data-entry.md ├── 07-data-validation.md ├── 08-input-modes.md ├── 09-navigation.md ├── 10-notifications.md ├── 11-writing.md └── 12-browser-support.md ├── history.md ├── icons.svg ├── index.html ├── js ├── style-guide.js └── vendor │ ├── clipboard.min.js │ ├── flickity.pkgd.min.js │ ├── iframe-resizer.min.js │ ├── iframeResizer.contentWindow.min.js │ ├── jquery-3.1.0.min.js │ ├── parsley.min.js │ ├── pikaday.js │ ├── prism.js │ ├── svg4everybody.min.js │ └── webtrends.min.js ├── page-templates.md ├── patterns ├── 01-molecules-02-blocks-card │ ├── 01-molecules-02-blocks-card.markup-only.html │ ├── 01-molecules-02-blocks-card.mustache │ └── 01-molecules-02-blocks-card.rendered.html ├── 01-molecules-02-blocks-hero-blue-tint │ ├── 01-molecules-02-blocks-hero-blue-tint.markup-only.html │ ├── 01-molecules-02-blocks-hero-blue-tint.mustache │ └── 01-molecules-02-blocks-hero-blue-tint.rendered.html ├── 01-molecules-02-blocks-hero-red-tint │ ├── 01-molecules-02-blocks-hero-red-tint.markup-only.html │ ├── 01-molecules-02-blocks-hero-red-tint.mustache │ └── 01-molecules-02-blocks-hero-red-tint.rendered.html └── 01-molecules-02-blocks-hero │ ├── 01-molecules-02-blocks-hero.markup-only.html │ ├── 01-molecules-02-blocks-hero.mustache │ └── 01-molecules-02-blocks-hero.rendered.html ├── release-history.html ├── roadmap.md ├── styles ├── 01-index.md ├── 02-design-tokens.md ├── 03-color.md ├── 04-typography.md ├── 05-iconography.md ├── 06-imagery.md ├── 07-motion.md └── 08-voice-tone.md ├── support.md └── utilities └── 00-index.md /.gitignore: -------------------------------------------------------------------------------- 1 | _site 2 | .sass-cache 3 | .jekyll-metadata 4 | .DS_Store 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2013-14 Brad Frost, http://bradfrost.com & Dave Olsen, http://dmolsen.com 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | this software and associated documentation files (the "Software"), to deal in 7 | the Software without restriction, including without limitation the rights to 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software is furnished to do so, 10 | subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Style Guide Guide 2 | 3 | Style Guide Guide is a boilerplate for creating a custom style guide for your organization's design system. It provides just enough IA and hooks to get you going. As a bonus, I've provided links to helpful resources and inspiration to help you as you create your own custom style guide. 4 | 5 | [See the demo here](http://bradfrost.github.io/style-guide-guide/) 6 | 7 | ## How it works 8 | Style Guide Guide is built using [Jekyll](https://jekyllrb.com/), a static site generator which works quite well for managing the content of a style guide. 9 | 10 | The tool can consume and display components from anywhere, but in my own workflow we import patterns from [Pattern Lab](http://patternlab.io/) into Style Guide Guide for display. For more info, check out this blog post (coming soon for now). 11 | 12 | ## Getting Started 13 | 1. Download or clone the files from the [repository on Github](https://github.com/bradfrost/style-guide-guide). 14 | 2. In the command line, navigate to the root of the project and run the `jekyll serve` command. This will build the static site and watch for changes. 15 | 3. Visit `http://127.0.0.1:4000/` in your browser to see the style guide. 16 | 17 | From here, obviously the point is to customize the style guide for your needs and populate it with your content and components. 18 | 19 | ## Importing components and assets from Pattern Lab 20 | Coming soon! 21 | 22 | ## Feedback and Questions 23 | If you have questions or issues with Style Guide Guide, please feel free to [open an issue](https://github.com/bradfrost/style-guide-guide/issues). If your organization is creating a design system and style guide and would like some help taking it to the next level, feel free to [get in touch!](http://bradfrost.com/contact/) 24 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | # Welcome to Jekyll! 2 | # 3 | # This config file is meant for settings that affect your whole blog, values 4 | # which you are expected to set up once and rarely need to edit after that. 5 | # For technical reasons, this file is *NOT* reloaded automatically when you use 6 | # 'jekyll serve'. If you change this file, please restart the server process. 7 | 8 | # Site settings 9 | title: Style Guide Guide 10 | email: brad@bradfrost.com 11 | description: > # this means to ignore newlines until "baseurl:" 12 | Write an awesome description for your new site here. You can edit this 13 | line in _config.yml. It will appear in your document head meta (for 14 | Google search results) and in your feed.xml site description. 15 | baseurl: "/style-guide-guide" # the subpath of your site, e.g. /blog 16 | url: "http://yourdomain.com" # the base hostname & protocol for your site 17 | twitter_username: brad_frost 18 | github_username: bradfrost 19 | 20 | # Build settings 21 | markdown: kramdown 22 | -------------------------------------------------------------------------------- /_includes/badge.html: -------------------------------------------------------------------------------- 1 | {% if page.status %} 2 | {% assign status = page.status %} 3 | {% elsif componentPage.status %} 4 | {% assign status = componentPage.status %} 5 | {% endif %} 6 | 7 | {% if status == 'Deprecated' %} 8 | {% assign badge = "negative" %} 9 | {% elsif status == 'Complete' %} 10 | {% assign badge = "positive" %} 11 | {% else %} 12 | {% assign badge = "caution" %} 13 | {% endif %} 14 | 15 | {% if status %} 16 | {{ status }} 17 | {% endif %} 18 | -------------------------------------------------------------------------------- /_includes/breadcrumbs.html: -------------------------------------------------------------------------------- 1 | {% if page.group %} 2 |
15 | {% endif %} 16 | -------------------------------------------------------------------------------- /_includes/card.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |{{ my_page.description }}
19 | 20 |<button class="c-btn">Button</button>
24 | Tab 2 content
27 | Tab 3 content
30 | {{ variation.styleModifier }}
{% endif %}{% highlight liquid %}{% include {{ markupOnlyPath }} %}{% endhighlight %}
35 | Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam
18 | 19 |{{ excerpt }}
{{/ excerpt }} 22 | 23 |Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam
43 | 44 |This is the hero description that will describe the contents of the hero
7 | 17 | 18 | 19 | 20 |{{{ excerpt }}}
{{/ excerpt }} {{> molecules-button }} 9 | 10 |This is the hero description that will describe the contents of the hero
32 | 42 | 43 | 44 | 45 |This is the hero description that will describe the contents of the hero
7 | 17 | 18 | 19 | 20 |{{{ excerpt }}}
{{/ excerpt }} {{> molecules-button }} 9 | 10 |This is the hero description that will describe the contents of the hero
32 | 42 | 43 | 44 | 45 |This is the hero description that will describe the contents of the hero
7 | 17 | 18 | 19 | 20 |{{{ excerpt }}}
{{/ excerpt }} {{> molecules-button }} 9 | 10 |This is the hero description that will describe the contents of the hero
34 | 44 | 45 | 46 | 47 |{{ componentPage.description }}
35 | 36 |{{ variation.styleModifier }}
{% endif %}See the Pen {{ variation.codepenID }} (@{{ variation.codepenID }}) on CodePen.
36 | 37 | {% endif %} 38 | 39 | {% if variation.includeClassification and variation.includeCategory and variation.includeName %} 40 | 41 | {% if variation.includeClassification == 'atoms' %} 42 | {% assign atomicNumber = "00" %} 43 | {% elsif variation.includeClassification == 'molecules' %} 44 | {% assign atomicNumber = "01" %} 45 | {% elsif variation.includeClassification == 'organisms' %} 46 | {% assign atomicNumber = "02" %} 47 | {% endif %} 48 | 49 | {% capture componentString %}{{ atomicNumber }}-{{ variation.includeClassification }}-{{ variation.includeCategory }}-{{ variation.includeName }}{% endcapture %} 50 | 51 | {% capture path %}/patterns/{{ componentString }}/{{ componentString }}.rendered.html{% endcapture %} 52 | 53 |{% highlight liquid %}{% include {{ markupOnlyPath }} %}{% endhighlight %}
119 | THIS IS ANGULAR CODE
129 | THIS IS REACT CODE
138 | Class Name | 177 |Description | 178 |
---|---|
188 | {{ class.className }} 189 | | 190 | 191 |192 | {% capture desc %}{{ class.description }}{% endcapture %} 193 | {% if class.description %}{{ desc | markdownify }}{% endif %} 194 | | 195 | 196 |
{{ variation.styleModifier }}
{{ variation.description }}
31 |`. 50 | 51 | fine-print: 52 | - version: 0.3 53 | update: April 27, 2017 54 | owner: Jane Doe 55 | --- 56 | -------------------------------------------------------------------------------- /components/blocks-and-cards/hero.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: blocks-and-cards 5 | permalink: /components/blocks-and-cards/hero.html 6 | 7 | title: Hero 8 | status: In Progress 9 | description: Large-format unit to promote content with a high-impact image 10 | 11 | variations: 12 | - title: Default hero 13 | description: Default hero that has no gradient overlay 14 | styleModifier: c-hero 15 | includeClassification: molecules 16 | includeCategory: 02-blocks 17 | includeName: hero 18 | - title: Blue tint hero 19 | description: Hero with a blue gradient overlay 20 | styleModifier: c-hero c-hero--blue-tint 21 | includeClassification: molecules 22 | includeCategory: 02-blocks 23 | includeName: hero-blue-tint 24 | - title: Red tinted hero 25 | description: Hero with a red gradient overlay 26 | styleModifier: c-hero c-hero--red-tint 27 | includeClassification: molecules 28 | includeCategory: 02-blocks 29 | includeName: hero-red-tint 30 | 31 | usage: 32 | - title: When to use 33 | description: Usage description. 34 | - title: When to consider an alternative 35 | description: Alternative usage. 36 | 37 | classes: 38 | - className: c-hero 39 | required : yes 40 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 41 | - className: c-hero--bare 42 | modifier : yes 43 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 44 | - className: c-hero--tinted 45 | modifier : yes 46 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 47 | - className: c-hero__body 48 | required: yes 49 | description: Apply to the container for the card body, which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 50 | - className: c-hero__title 51 | recommended: yes 52 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 56 | 57 | fine-print: 58 | - version: 0.3 59 | update: April 27, 2017 60 | owner: Jane Doe 61 | --- 62 | -------------------------------------------------------------------------------- /components/blocks-and-cards/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: blocks-and-cards 5 | permalink: /components/blocks-and-cards/ 6 | 7 | title: Blocks and Cards 8 | description: A block component that consists of a header, body, and footer. 9 | --- 10 | -------------------------------------------------------------------------------- /components/blocks-and-cards/tile.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: blocks-and-cards 5 | permalink: /components/blocks-and-cards/tile.html 6 | 7 | title: Tile 8 | status: Deprecated 9 | description: Tile description 10 | 11 | variations: 12 | - title: Tile 13 | description: Tile description 14 | styleModifier: c-tile 15 | includeClassification: molecules 16 | includeCategory: 02-blocks 17 | includeName: card 18 | 19 | usage: 20 | - title: When to use 21 | description: Usage description. 22 | - title: When to consider an alternative 23 | description: Alternative usage. 24 | 25 | classes: 26 | - className: c-hero 27 | required : yes 28 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 29 | - className: c-hero--bare 30 | modifier : yes 31 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 32 | - className: c-hero--tinted 33 | modifier : yes 34 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 35 | - className: c-hero__body 36 | required: yes 37 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 38 | - className: c-hero__title 39 | recommended: yes 40 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 44 | 45 | fine-print: 46 | - version: 0.3 47 | update: April 27, 2017 48 | owner: Jane Doe 49 | --- 50 | -------------------------------------------------------------------------------- /components/buttons/button-group.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: buttons 5 | permalink: /components/buttons/button-group.html 6 | 7 | title: Button group 8 | description: Button group description 9 | 10 | variations: 11 | - title: Button group 12 | description: Button group description 13 | styleModifier: c-btn-group 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/buttons/button.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: buttons 5 | permalink: /components/buttons/button.html 6 | 7 | title: Button 8 | description: Button description 9 | 10 | variations: 11 | - title: Button 12 | description: Button description 13 | styleModifier: c-btn 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | 49 | --- 50 | -------------------------------------------------------------------------------- /components/buttons/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: buttons 5 | permalink: /components/buttons/ 6 | 7 | title: Buttons 8 | description: Button styles and interactions for every context 9 | --- 10 | -------------------------------------------------------------------------------- /components/buttons/text-button.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: buttons 5 | permalink: /components/buttons/text-button.html 6 | 7 | title: Text button 8 | description: Text button description 9 | 10 | variations: 11 | - title: Text button 12 | description: Text button description 13 | styleModifier: c-text-btn 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/charts-and-graphs/bar-graph.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: charts-and-graphs 5 | permalink: /components/charts-and-graphs/bar-graph.html 6 | 7 | title: Bar graph 8 | description: Bar graph description 9 | 10 | variations: 11 | - title: Bar graph 12 | description: Bar graph description 13 | styleModifier: c-bar-graph 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/charts-and-graphs/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: charts-and-graphs 5 | permalink: /components/charts-and-graphs/ 6 | 7 | title: Charts and graphs 8 | description: Essential data-viz patterns 9 | --- 10 | -------------------------------------------------------------------------------- /components/form-controls/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: form-controls 5 | permalink: /components/form-controls/ 6 | 7 | title: Form controls 8 | description: Components for efficient data entry 9 | 10 | --- 11 | -------------------------------------------------------------------------------- /components/form-controls/text-field.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: form-controls 5 | permalink: /components/form-controls/text-field.html 6 | 7 | title: Text field 8 | description: Text field description 9 | 10 | variations: 11 | - title: Text field 12 | description: Text field description 13 | styleModifier: c-text-field 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/headers-and-footers/footer.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: headers-and-footers 5 | image: ../../images/c-footer.png 6 | permalink: /components/headers-and-footers/footers.html 7 | 8 | title: Footer 9 | description: Logo and housekeeping links displayed at page bottom 10 | 11 | variations: 12 | - title: Footer 13 | description: Footer description 14 | styleModifier: c-footer 15 | includeClassification: molecules 16 | includeCategory: 02-blocks 17 | includeName: card 18 | 19 | usage: 20 | - title: When to use 21 | description: Usage description. 22 | - title: When to consider an alternative 23 | description: Alternative usage. 24 | 25 | classes: 26 | - className: c-hero 27 | required : yes 28 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 29 | - className: c-hero--bare 30 | modifier : yes 31 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 32 | - className: c-hero--tinted 33 | modifier : yes 34 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 35 | - className: c-hero__body 36 | required: yes 37 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 38 | - className: c-hero__title 39 | recommended: yes 40 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 44 | 45 | fine-print: 46 | - version: 0.3 47 | update: April 27, 2017 48 | owner: Jane Doe 49 | --- 50 | -------------------------------------------------------------------------------- /components/headers-and-footers/horizontal-header.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: headers-and-footers 5 | image: ../../images/c-header.png 6 | permalink: /components/headers-and-footers/horizontal-header.html 7 | 8 | title: Horizontal header 9 | description: Displays a full-width header on wide screens and a hamburger menu on small screens. 10 | 11 | variations: 12 | - title: Horizontal header 13 | description: Horizontal header description 14 | styleModifier: c-header 15 | includeClassification: molecules 16 | includeCategory: 02-blocks 17 | includeName: card 18 | 19 | usage: 20 | - title: When to use 21 | description: Usage description. 22 | - title: When to consider an alternative 23 | description: Alternative usage. 24 | 25 | classes: 26 | - className: c-hero 27 | required : yes 28 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 29 | - className: c-hero--bare 30 | modifier : yes 31 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 32 | - className: c-hero--tinted 33 | modifier : yes 34 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 35 | - className: c-hero__body 36 | required: yes 37 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 38 | - className: c-hero__title 39 | recommended: yes 40 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 44 | 45 | fine-print: 46 | - version: 0.3 47 | update: April 27, 2017 48 | owner: Jane Doe 49 | --- 50 | -------------------------------------------------------------------------------- /components/headers-and-footers/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: headers-and-footers 5 | permalink: /components/headers-and-footers/ 6 | 7 | title: Headers and footers 8 | description: Responsive containers for app title, navigation, and search 9 | --- 10 | -------------------------------------------------------------------------------- /components/headers-and-footers/vertical-header.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: headers-and-footers 5 | image: ../../images/c-header--vertical.png 6 | permalink: /components/headers-and-footers/vertical-header.html 7 | 8 | title: Vertical header 9 | description: Vertical sidebar navigation on wide screens and hamburger navigation on small screens. 10 | 11 | variations: 12 | - title: Vertical header 13 | description: Vertical header 14 | styleModifier: c-header c-header--vertical 15 | includeClassification: molecules 16 | includeCategory: 02-blocks 17 | includeName: card 18 | 19 | usage: 20 | - title: When to use 21 | description: Usage description. 22 | - title: When to consider an alternative 23 | description: Alternative usage. 24 | 25 | classes: 26 | - className: c-hero 27 | required : yes 28 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 29 | - className: c-hero--bare 30 | modifier : yes 31 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 32 | - className: c-hero--tinted 33 | modifier : yes 34 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 35 | - className: c-hero__body 36 | required: yes 37 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 38 | - className: c-hero__title 39 | recommended: yes 40 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 44 | 45 | fine-print: 46 | - version: 0.3 47 | update: April 27, 2017 48 | owner: Jane Doe 49 | --- 50 | -------------------------------------------------------------------------------- /components/icons/icons.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: icons 5 | permalink: /components/icons/icons.html 6 | 7 | title: Icons 8 | description: Icons description 9 | 10 | variations: 11 | - title: Icons 12 | description: Icons description 13 | styleModifier: c-icon 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/icons/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: icons 5 | permalink: /components/icons/ 6 | 7 | title: Icons 8 | description: Icon reference and usage 9 | --- 10 | -------------------------------------------------------------------------------- /components/interactive/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: interactive 5 | permalink: /components/interactive/ 6 | 7 | title: Interactive 8 | description: Components for revealing/hiding content for more compressed and focused layouts 9 | --- 10 | -------------------------------------------------------------------------------- /components/interactive/tabs.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: interactive 5 | permalink: /components/interactive/tabs.html 6 | 7 | title: Tabs 8 | description: Unordered list of links where the each link targets different information 9 | 10 | variations: 11 | - title: Tabs 12 | description: Tabs description 13 | styleModifier: c-tabs 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/lists-and-collections/card-list.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: lists-and-collections 5 | permalink: /components/lists-and-collections/card-list.html 6 | 7 | title: Card list 8 | description: Card description 9 | 10 | variations: 11 | - title: Default card list 12 | description: Card list description 13 | styleModifier: c-card-list 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/lists-and-collections/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: lists-and-collections 5 | permalink: /components/lists-and-collections/ 6 | 7 | title: Lists and collections 8 | description: From simple text lists to complex card collections 9 | --- 10 | -------------------------------------------------------------------------------- /components/lists-and-collections/tile-list.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: lists-and-collections 5 | permalink: /components/lists-and-collections/tile-list.html 6 | 7 | title: Tile list 8 | description: Tile description 9 | 10 | variations: 11 | - title: Tile list 12 | description: Tile list description 13 | styleModifier: c-tile-list 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/media/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: media 5 | permalink: /components/media/ 6 | 7 | title: Media 8 | description: Images and video 9 | --- 10 | -------------------------------------------------------------------------------- /components/media/video.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: media 5 | permalink: /components/media/video.html 6 | 7 | title: Video 8 | description: Video description 9 | 10 | variations: 11 | - title: Video 12 | description: Video description 13 | styleModifier: c-video 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/messaging/alert.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: messaging 5 | permalink: /components/messaging/alert.html 6 | 7 | title: Alert 8 | description: Alert description 9 | 10 | variations: 11 | - title: Alert 12 | description: Alert description 13 | styleModifier: c-alert 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/messaging/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: messaging 5 | permalink: /components/messaging/ 6 | 7 | title: Messaging 8 | description: Tools for status and info updates, from micro-copy tooltips to high-impact alerts 9 | --- 10 | -------------------------------------------------------------------------------- /components/messaging/tooltip.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: messaging 5 | permalink: /components/messaging/tooltip.html 6 | 7 | title: Tooltip 8 | description: Tooltip description 9 | 10 | variations: 11 | - title: Tooltip 12 | description: Tooltip description 13 | styleModifier: c-tooltip 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/navigation/breadcrumbs.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: navigation 5 | permalink: /components/navigation/breadcrumbs.html 6 | 7 | title: Breadcrumbs 8 | description: Ordered list showing what level you are on in reference to the site 9 | 10 | variations: 11 | - title: Breadcrumbs 12 | description: Breadcrumbs description 13 | styleModifier: c-breadcrumbs 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | 19 | usage: 20 | - title: When to use 21 | description: Usage description. 22 | - title: When to consider an alternative 23 | description: Alternative usage. 24 | 25 | classes: 26 | - className: c-hero 27 | required : yes 28 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 29 | - className: c-hero--bare 30 | modifier : yes 31 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 32 | - className: c-hero--tinted 33 | modifier : yes 34 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 35 | - className: c-hero__body 36 | required: yes 37 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 38 | - className: c-hero__title 39 | recommended: yes 40 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 44 | 45 | fine-print: 46 | - version: 0.3 47 | update: April 27, 2017 48 | owner: Jane Doe 49 | --- 50 | -------------------------------------------------------------------------------- /components/navigation/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: navigation 5 | permalink: /components/navigation/ 6 | 7 | title: Navigation 8 | description: Components for wayfinding (see also [headers and footers](../headers-and-footers/index.html)) 9 | --- 10 | -------------------------------------------------------------------------------- /components/tables/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: tables 5 | permalink: /components/tables/ 6 | 7 | title: Tables 8 | description: Responsive data display for a range of contexts 9 | --- 10 | -------------------------------------------------------------------------------- /components/tables/table.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: tables 5 | permalink: /components/table/table.html 6 | 7 | title: Table 8 | description: Table description 9 | 10 | variations: 11 | - title: Table 12 | description: Table description 13 | styleModifier: c-table 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/text/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-category 3 | group: components 4 | subgroup: text 5 | permalink: /components/text/ 6 | 7 | title: Text 8 | description: Text components description 9 | 10 | --- 11 | -------------------------------------------------------------------------------- /components/text/page-header.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: text 5 | permalink: /components/text/page-header.html 6 | 7 | title: Page header 8 | description: Block that consists of of a page header title and description. Used to headline a page. 9 | 10 | variations: 11 | - title: Page header 12 | description: Page header description 13 | styleModifier: c-page-header 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/text/section-header.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: text 5 | permalink: /components/text/section-header.html 6 | 7 | title: Section header 8 | description: Block that consists of of a section header title and description. Used to headline a section. 9 | 10 | variations: 11 | - title: Section header 12 | description: Section header description 13 | styleModifier: c-section-header 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`. 43 | 44 | fine-print: 45 | - version: 0.3 46 | update: April 27, 2017 47 | owner: Jane Doe 48 | --- 49 | -------------------------------------------------------------------------------- /components/text/text-passage.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: component-detail 3 | group: components 4 | subgroup: text 5 | permalink: /components/text/text-passage.html 6 | 7 | title: Text passage 8 | description: A passage of text, including various components (i.e. article, blog post) 9 | 10 | variations: 11 | - title: Text passage 12 | description: Text passage description 13 | styleModifier: c-text-passage 14 | includeClassification: molecules 15 | includeCategory: 02-blocks 16 | includeName: card 17 | 18 | usage: 19 | - title: When to use 20 | description: Usage description. 21 | - title: When to consider an alternative 22 | description: Alternative usage. 23 | 24 | classes: 25 | - className: c-hero 26 | required : yes 27 | description: Apply to the hero block's containing HTML element. This class sets up the background-image handling and text color for the unit. The `c-hero` element should have just one immediate child, the `c-hero__body` element. Note, too, that the unit's hero image should be applied as a background image to this `c-hero` element. 28 | - className: c-hero--bare 29 | modifier : yes 30 | description: Add to the `c-hero` element to remove the default gradient overlay from the hero image. 31 | - className: c-hero--tinted 32 | modifier : yes 33 | description: Add to the `c-hero` element to replace the default gradient overlay with a solid, uniform tint. 34 | - className: c-hero__body 35 | required: yes 36 | description: Apply to the container for the card body, Which typically includes a title and description (see below) but can include any arbitrary markup including buttons for a call to action. The class manages the card's background gradient. 37 | - className: c-hero__title 38 | recommended: yes 39 | description: Apply to the card's heading inside the card body. The recommended element for this class is `
`.
43 |
44 | fine-print:
45 | - version: 0.3
46 | update: April 27, 2017
47 | owner: Jane Doe
48 | ---
49 |
--------------------------------------------------------------------------------
/components/view-all.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: component-viewall
3 | group: components
4 | permalink: /components/view-all.html
5 |
6 | title: All Components
7 | description: This is the components overview description.
8 | ---
9 |
--------------------------------------------------------------------------------
/contribute.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: page
3 | title: Contributing to the design system
4 | description: This page explains the process (or processes) by which the design system gets updated
5 | ---
6 |
7 | ## People
8 | Describe who's involved in changes to the system. Describe who's expected to do the work and who approves changes.
9 |
10 | ## Process
11 | Describe specifically the process or processes by which the system gets [updated](http://atomicdesign.bradfrost.com/chapter-5/#making-changes-to-patterns). What happens when existing component need modified? What if an entire new component needs created? What happens if a component is deprecated? See [Canonical's fantastic decision tree](http://design.canonical.com/2016/07/getting-vanilla-ready-for-v1-the-roadmap/) for contributing changes to their design system.
12 |
13 | Since a design system is made up of component code, guidelines, documentation, design tools, and resources, keep in mind you'll likely need to define several processes to contribute each of these ingredients.
14 |
15 | ## Support
16 | Cross-linking to the support page is a good idea here.
17 |
--------------------------------------------------------------------------------
/css/main.scss:
--------------------------------------------------------------------------------
1 | ---
2 | # Only the main Sass file needs front matter (the dashes are enough)
3 | ---
4 |
5 | /*------------------------------------*\
6 | #TABLE OF CONTENTS
7 | \*------------------------------------*/
8 | /**
9 | * ABSTRACTS..............................Declarations of Sass variables & mixins
10 | * BASE...................................Default element styles
11 | * .....Body
12 | * .....Links
13 | * .....Headings
14 | * .....Forms
15 | * .....Defaults
16 | * LAYOUT.................................Layout-specific styles
17 | * COMPONENTS.............................Component styles
18 | * UTILITIES..............................Utility classes
19 | */
20 |
21 | @charset "utf-8";
22 |
23 | /*------------------------------------*\
24 | #ABSTRACTS
25 | \*------------------------------------*/
26 | @import "abstracts/variables";
27 | @import "abstracts/mixins";
28 |
29 |
30 |
31 |
32 |
33 | /*------------------------------------*\
34 | #BASE
35 | \*------------------------------------*/
36 | @import "base/body";
37 | @import "base/buttons";
38 | @import "base/forms";
39 | @import "base/headings";
40 | @import "base/links";
41 | @import "base/lists";
42 | @import "base/main";
43 | @import "base/media";
44 | @import "base/reset";
45 | @import "base/tables";
46 | @import "base/text";
47 |
48 |
49 |
50 |
51 |
52 | /*------------------------------------*\
53 | #LAYOUT
54 | \*------------------------------------*/
55 | @import "layout/layout";
56 |
57 |
58 |
59 |
60 |
61 | /*------------------------------------*\
62 | #COMPONENTS
63 | \*------------------------------------*/
64 | @import "components/breadcrumbs";
65 | @import "components/buttons";
66 | @import "components/button-group";
67 | @import "components/card";
68 | @import "components/footer-nav";
69 | @import "components/footer";
70 | @import "components/header";
71 | @import "components/hero";
72 | @import "components/logo";
73 | @import "components/icon";
74 | @import "components/page-header";
75 | @import "components/primary-nav";
76 | @import "components/section";
77 | @import "components/table";
78 | @import "components/tabs";
79 | @import "components/text-passage";
80 | @import "components/tile";
81 |
82 |
83 |
84 |
85 |
86 | /*------------------------------------*\
87 | #UTILITIES
88 | \*------------------------------------*/
89 | @import "utilities/visibility";
90 | @import "utilities/display";
91 |
--------------------------------------------------------------------------------
/css/style-guide.scss:
--------------------------------------------------------------------------------
1 | ---
2 | ---
3 |
4 | $color-white: #ffffff;
5 | $color-gray-dark: #333333;
6 | $color-gray-lighter: #f5f5f5;
7 | $color-gray-10: #e5e5e5;
8 | $color-gray-04: #f5f5f5;
9 |
10 | $color-app-red: #d82424;
11 | $color-app-green: #00af53;
12 | $color-app-ruby: #b10040;
13 | $color-app-blue: #225896;
14 | $color-app-sea-blue: #005f7f;
15 | $color-app-torquoise: #00aca8;
16 | $color-app-med-gray: #545459;
17 |
18 | $color-app-blue-light: #e1efff;
19 | $color-app-blue-deep: #111122;
20 |
21 | $anim-base-easing: ease;
22 | $anim-base-duration: .3s;
23 |
24 | /**
25 | * Max Width
26 | */
27 | $l-max-width: 84em;
28 | $l-max-width-text: 38em;
29 |
30 | /**
31 | * Breakpoints
32 | */
33 | $bp-small: 24em;
34 | $bp-small-2: 30em;
35 | $bp-med: 35em;
36 | $bp-large: 47em;
37 | $bp-xl: 62em;
38 | $bp-xl-2: 67em;
39 | $bp-xl-3: $l-max-width;
40 |
41 | /**
42 | * 1) This is an overide to have more text breathing room on home
43 | */
44 | @media all and (min-width: 62em) {
45 | .c-section--home {
46 | padding: 0 3rem;
47 | }
48 | }
49 |
50 | /*------------------------------------*\
51 | #IFFFRAME
52 | \*------------------------------------*/
53 |
54 | /**
55 | * 1) Iffframe creates a resizable component
56 | */
57 |
58 | .iffframe {
59 | padding: 1rem 0.7rem 1rem 0;
60 | width: 100%;
61 | position: relative;
62 | border: 1px solid $color-gray-lighter;
63 | border-left: none;
64 | overflow: hidden;
65 | height: auto;
66 | background-color: $color-white;
67 | margin-bottom: 2rem;
68 | //transition: width 0.6s $anim-base-easing;
69 | }
70 |
71 | .iffframe__iframe {
72 | width: 100%;
73 | overflow: auto;
74 | overflow-x: auto !important;
75 | }
76 |
77 | /**
78 | * Iffframe handle
79 | * 1) Hide resize handle for small screens
80 | */
81 | .iffframe__handle {
82 | display: none; /* 1 */
83 | width: 0.7rem;
84 | height: 100%;
85 | position: absolute;
86 | right: 0;
87 | top: 0;
88 | cursor: col-resize;
89 | background-color: $color-gray-lighter;
90 | transition: background-color $anim-base-duration $anim-base-easing;
91 |
92 | &:after {
93 | content: "";
94 | display: block;
95 | height: 1rem;
96 | width: 2px;
97 | border-right: 1px solid #aaa;
98 | border-left: 1px solid #aaa;
99 | position: absolute;
100 | top: 50%;
101 | left: 50%;
102 | margin-top: -0.5rem;
103 | margin-left: -1px;
104 | }
105 |
106 | &:hover {
107 | background: #e5e5e5;
108 | }
109 |
110 | &:active {
111 | background: #cccccd;
112 | }
113 |
114 | @media all and (min-width: 40em) {
115 | display: block;
116 | }
117 | }
118 |
119 | // Failed attempt to get the icon grid looking better
120 | // li.icon-grid__item.c-well {
121 | // padding: 1rem !important;
122 | // border-color: $color-gray-10;
123 | // background-color: $color-gray-04;
124 |
125 | // h3 {
126 | // margin-top: 2rem;
127 | // }
128 | // }
129 |
130 |
131 |
132 | /*------------------------------------*\
133 | #CODE
134 | \*------------------------------------*/
135 |
136 | /**
137 | * 1) Override some Prism defaults
138 | * 2) Fixed width button for showing and hiding code
139 | * 3) Change background color
140 | * 4) Update the code color to have Exxon colors
141 | */
142 | code[class*="language-"], pre[class*="language-"] {
143 | tab-size: 2;
144 | }
145 |
146 | .pattern-code {
147 | position: relative;
148 | margin-top: 2rem;
149 | }
150 |
151 | /**
152 | * Applied to pre element
153 | */
154 | .pattern-code-block {
155 | margin-top: 0;
156 | max-height: 25rem;
157 | overflow-y: hidden;
158 |
159 | .is-expanded & {
160 | max-height: none;
161 | }
162 | }
163 |
164 | .pattern-code-copy-btn {
165 | position: absolute;
166 | top: 0;
167 | right: 0;
168 | z-index: 2;
169 | }
170 |
171 | /* 3 */
172 | pre[class*="language-"] {
173 | background-color: $color-gray-04;
174 | }
175 |
176 | code[class*="language-"], pre[class*="language-"] {
177 | text-shadow: none;
178 | }
179 |
180 | /**
181 | * Push the button up to be closer to the code-block in the show-more block
182 | */
183 | .c-btn {
184 | .show-more & {
185 | position: relative;
186 | bottom: 2rem;
187 | z-index: 1;
188 | }
189 | }
190 |
191 | /**
192 | * Force last paragraph of page header description to be inline so markdown flows into "Jump To Usage Guidelines Link"
193 | */
194 | .c-page-header__desc {
195 | p {
196 | &:last-of-type {
197 | display: inline;
198 | }
199 | }
200 | }
201 |
202 | /**
203 | * Page header icon
204 | * 1) Add height and width for the page header icon for the "Jump to Usage Guidelines Link"
205 | * 2) Added within the header__desc to cancel out text-passage styles;
206 | */
207 | .c-page-header__icon {
208 |
209 | .c-page-header__desc & {
210 | height: 1rem; /* 1 */
211 | width: 1rem; /* 1 */
212 | }
213 | }
214 |
215 | /**
216 | * Tabs list in reference site
217 | * 1) Wrap tabs
218 | * 2) Remove overflow
219 | * 3) Remove shadows for overflow
220 | */
221 | .c-tabs__list {
222 | @media all and (min-width: $bp-large) {
223 | flex-wrap: wrap; /* 1 */
224 | overflow-x: inherit; /* 2 */
225 | overflow-y: inherit; /* 2 */
226 | }
227 | }
228 |
229 |
230 | /*------------------------------------*\
231 | #BADGES
232 | \*------------------------------------*/
233 | .c-badge {
234 | border-radius: 4px;
235 | color: $color-white;
236 | font-size: .65rem;
237 | margin-left: 4px;
238 | padding: 4px;
239 | vertical-align: middle;
240 | }
241 |
242 | .c-badge--negative {
243 | background-color: $color-app-red;
244 | }
245 |
246 | .c-badge--positive {
247 | background-color: $color-app-green;
248 | }
249 |
250 | .c-badge--caution {
251 | background-color: $color-app-blue;
252 | }
253 |
254 |
255 |
256 |
257 |
258 | /*------------------------------------*\
259 | #BADGES
260 | \*------------------------------------*/
261 | .c-table-container {
262 | width: 100%;
263 | overflow-x: auto;
264 | overflow-y: hidden;
265 | background:
266 | linear-gradient(to right, white 30%, hsla(0,0%,100%,0)),
267 | linear-gradient(to right, hsla(0,0%,100%,0), white 70%) right,
268 | linear-gradient(to right, rgba(0,0,0,0.2) 0%, transparent 70%),
269 | linear-gradient(to left, rgba(0,0,0,0.2) 0%, transparent 70%) right;
270 | background-repeat: no-repeat;
271 | background-size: 40px 100%, 40px 100%, 14px 100%, 14px 100%;
272 | background-attachment: local, local, scroll, scroll;
273 | }
274 |
275 | .c-table__cell:first-child {
276 | white-space: nowrap;
277 | }
278 |
279 |
280 |
281 | /*------------------------------------*\
282 | #LAYOUT TWEAKS
283 | \*------------------------------------*/
284 |
285 | .push-right {
286 | padding-left: 0.5rem;
287 |
288 | @media all and (min-width: 40em) {
289 | padding-left: 8rem;
290 | }
291 | }
292 |
293 | .c-tabs-list__item {
294 | display: none;
295 |
296 | &.is-active {
297 | display: block;
298 | }
299 | }
300 |
--------------------------------------------------------------------------------
/downloads.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: page
3 | title: Downloads
4 | description: Links to repositories, design templates, tools, and so on.
5 | ---
6 | Check out [Carbon Design System's wonderful tools and resources page](http://carbondesignsystem.com/resources) for inspiration.
7 |
--------------------------------------------------------------------------------
/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/bradfrost/style-guide-guide/e77ec28a014b3bd7df318bb7e5eecdb63adbbb71/favicon.ico
--------------------------------------------------------------------------------
/feed.xml:
--------------------------------------------------------------------------------
1 | ---
2 | layout: null
3 | ---
4 |
5 |