Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
__snapshots__
__tests__
Heading.stories.js
README.md
consts.js
index.js
index.js.flow

README.md

Heading

To implement Heading component into your project you'll need to add the import:

import Heading from "@kiwicom/orbit-components/lib/Heading";

After adding import into your project you can use it simply like:

<Heading>Hello World!</Heading>

Props

Table below contains all types of the props available in Heading component.

Name Type Default Description
children React.Node The content of the Heading.
dataTest string Optional prop for testing purposes.
element enum "h1" The element used for the root node.
inverted boolean The true, the Heading color will be white.
spaceAfter enum Additional margin-bottom after component. See this docs
type enum "title1" The size type of Heading.

enum

element type
"h1" "display"
"h2" "title1"
"h3" "title2"
"h4" "title3"
"h5" "title4"
"h6" "title5"
"div"