@nib-components/content-heading v3.2.2

Setting up your component

Delete this section after you've setup the component

Before the component is accepted into the DLS:

1. Github: Create the repository under your own username/organisation

When the component is accepted into the DLS:

1. Github: Transfer ownership of the repository to frontend
2. BuildKite: Create a New Pipeline
3. BuildKite: Enter the following settings:

• Name: content-heading
• Git Repository: git@git.nib.com.au:frontend/content-heading.git

4. BuildKite: Remove the default Step and add a Read steps from repository step

• And add cd deploy && bundle install && bundle update sceptre sceptre-dotnet sceptre-app && bundle exec sceptre-app pipeline upload to the Commands to run textbox
• And add os=linux to the Agent Targeting Rules textbox

5. BuildKite: Create Pipeline and follow the instructions to add the webhook to GithubEnterprise
6. BuildKite: Go to Settings

• Check Build pull requests from third-party forked repositories and click Save Github Enterprise Settings
• Copy the Markdown badge from Settings and past it below.

7. Github: Edit the readme to remove these steps and kick off a New build
8. Github: Protect the master branch

• Go to Settings > Branches
• Choose the master branch
• Check Protect this branch
• Check Require status checks to pass before merging
• Check Include administrators and Require branches to be up to date before merging
• Check all Status checks found in the last week for this repository

@nib-components/content-heading

A content-heading component.

Installation

npm install --save @nib-components/content-heading

Usage

import ContentHeading from '@nib-components/content-heading';

const Heading1 = styled.h1``;

const Heading2 = styled.h2``;

const Heading3 = styled.h3``;

const Heading4 = styled.h4``;

const Heading5 = styled.h5``;

const headings = {
  1: Heading1,
  2: Heading2,
  3: Heading3,
  4: Heading4,
  5: Heading5
};

<ContentHeading headings={headings} size={3} text={text}/>;

Properties

headings

A map of heading components with the size value as the key. If not provided the default component is h${size}.

Optional. An object.

size

A number value for the Header size.

Required. A number.

text

The text displayed in the Header.

Required. A string.

Change log

1.0.0

Initial release.

Contributing

You can edit the files in ./src, whilst running npm run watch. This will compile for the ./dist folder.