Skip to content

Commit

Permalink
Merge pull request #122 from prysmex/eui-title-docs
Browse files Browse the repository at this point in the history
EuiTitle docs
  • Loading branch information
betocantu93 authored Mar 30, 2022
2 parents 7d4b745 + 0bf1ecc commit cada933
Showing 1 changed file with 50 additions and 26 deletions.
76 changes: 50 additions & 26 deletions packages/core/docs/display/title-demo/demo1.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,53 @@
# Demo
<EuiText>
<p>
<strong>EuiTitle</strong> styles the page, section, and content headings we use in Kibana. They can contain any markup, but usually contain a heading tag of some sort. Unlike <strong>EuiText</strong> they are margin neutral and more suitable for general layout design.
</p>
</EuiText>

```hbs template
<EuiTitle @size="l">
Title size="l"
</EuiTitle>
<EuiTitle @size="m">
Title size="m"
</EuiTitle>
<EuiTitle @size="s">
Title size="s"
</EuiTitle>
<EuiTitle @size="xs">
Title size="xs"
</EuiTitle>
<EuiTitle @size="xxs">
Title size="xxs"
</EuiTitle>
<EuiTitle @size="xxxs">
Title size="xxxs"
</EuiTitle>
<EuiSpacer />
You could also change the title tag using `@tagName`
<EuiTitle @tagName="h6">
This is an h6
</EuiTitle>
<div>
<EuiTitle @size='l'>
<h1>This is a large title, only one should exist per page</h1>
</EuiTitle>
<EuiCode @language='js'>size=&quot;l&quot;</EuiCode>
<EuiSpacer />
<EuiTitle>
<h2>This is the default size for title</h2>
</EuiTitle>
<EuiCode @language='js'>size=&quot;m&quot;</EuiCode>
<EuiSpacer />
<EuiTitle @size='s'>
<h3>This is a small title</h3>
</EuiTitle>
<EuiCode @language='js'>size=&quot;s&quot;</EuiCode>
<EuiSpacer />
<EuiTitle @size='xs'>
<h4>This is an extra small title</h4>
</EuiTitle>
<EuiCode @language='js'>size=&quot;xs&quot;</EuiCode>
<EuiSpacer />
<EuiTitle @size='xxs'>
<h5>This is an extra extra small title</h5>
</EuiTitle>
<EuiCode @language='js'>size=&quot;xxs&quot;</EuiCode>
<EuiSpacer />
<EuiTitle @size='xxxs'>
<h6>
This is an extra extra extra small title and should only be used when the
title is inconsequential (like a label)
</h6>
</EuiTitle>
<EuiCode @language='js'>size=&quot;xxxs&quot;</EuiCode>
<EuiHorizontalRule />
<EuiTitle @size='l'>
<span>Titles are markup agnostic, they only confer style</span>
</EuiTitle>
</div>
```

0 comments on commit cada933

Please sign in to comment.