node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org ยป

ar-atom-h1

AR atom - h1

A stateless h1, written in react, inline with atomic design principles

When should I use it

The component should be used whenever a h1 is needed, and passed the relevant properties for it to function and appear correctly in its context.

As an atom (see atomic design), it should likely be used as part of another component (organisms and molocules).

How should I use it

The h1 should be installed via npm, imported into you file/project and then used in situ

Install

yarn add ar-atom-h1

Import

import h1 from 'ar-atom-h1';

Example

<h1 />

How can I update it

Things to note

The component uses symantic versioning, with the intention of it being possible to use it in multiple places with the relevant feature for the context, and for developers to better reason if newer versions would break functionality.

Updating

Run the below commands to generate a development copy of the component and open it in a browser.

git clone git@github.com:gazzwi86/ar-atom-h1.git
yarn install
yarn start

You can then begin editing the files in the src directory. Once finished, update the examples in:

  • /README.md
  • /example/index.jsx

Publishing changes

Running the below command will bump the version number. You should then commit and push your changes to the git repository.

npm publish:<patch/minor/major>

Useful links