ark-plumbing-masthead

Ark Plumbing Masthead

NPM Version:

Introduction

As we will have multiple application in the future we wanted to be sure that had the same consistent style across the board with our Masthead. As this was the case we have created a component that we use can reuse, maintaining the same functionality and look across the estate.

Getting started

To install the masthead component use the following command:

npm install ark-plumbing-masthead --save

This will save the component to your dependencies.

Using the component

To use the component use the following line of code to import the distributed Masthead file:

import Masthead from 'ark-plumbing-masthead/dist/Masthead';

The masthead itself makes use of a Javascript object which you can have anywhere, just as long as you import it into the component.

To the use the component the line of code below will set it up for you:

<Masthead
  siteTitle="Plumbing UI"
  mastheadData={mastheadData}
  homeLink="/"
/>