Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 1.74 KB

README.md

File metadata and controls

60 lines (45 loc) · 1.74 KB

Lyef full header

Build Status Badge size Badge gzip size NPM version

A gif with header containing video

Demo

Live examples

Installation

$ npm install --save lyef-full-header

Basic Usage

import FullHeader from 'lyef-full-header';

...
render() {
    return (
        <FullHeader
            title="lyef"
            subtitle="What is tested may never break."
            bgColor="#EBE9EB"
            textColor="#3299BB"
            font="Lobster"
            video="videos/my_video.mp4"
        />
    );
}
...

Props

  • title (string) - main title
  • subtitle (string) - subtitle
  • bgColor (string) - background color
  • bgImg (string) - image to background
  • video (string) - video to background
  • textColor (string) - texts color
  • font (string) - font-family to texts

Architecture

We've developed this component using the following boilerplate: lyef-react-component.

If you want to contribute with this component: Contributing Documentation.

License

MIT License @ lyef