@comparaonline/ui-hero-header
v0.27.1
Published
React component to render the `Hero Header`.
Downloads
38
Maintainers
Keywords
Readme
@comparaonline/ui-hero-header
React component to render the Hero Header
.
Installation
yarn add @comparaonline/ui-hero-header
Usage
The HeroHeader
requires a title
prop (string), and aditionally you can add a subtitle
and a backgroundImage
prop.
import HeroHeader from '@comparaonline/ui-hero-header';
return (
<HeroHeader
title={'Title'}
subtitle={'Title'}
backgroundImage={'http://google.cl/niceImage.jpg'}
/>
);
| key | required | type | description |
| ----------------- | -------- | ---------- | ------------------------------------------ |
| title
| true
| string
| The string to be displayed as the title |
| subtitle
| true
| string
| The string to be displayed as the subtitle |
| backgroundImage
| false
| function
| The href
value, it should be absolute |