Project Name

@mark33mark/react-component-library

A private component library I will be working on over time to add components I develop and like enough to place in this library.

Table of contents

• Project
  • Getting Started
  • Installation
  • Components in Library
    • 1. Button
    • 2. Signup
  • Contributing
  • Credits
  • Built With
  • Versioning
  • Authors
  • License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

npm i @mark33mark/react-component-library

Components in library

1. Button

Inside your component, import Button as follows:

import { Button } from '@mark33mark/react-component-library'

Options

| Attribute | Type | Default value | | --- | --- | --- | | primary | bool | true | | label | string | Button | | backgroundColor | string | '#1ea7fd' | | fontFamily | string | 'Nunito' | | size | string | 'medium' |

Example:

import { Button } from '@mark33mark/react-component-library';

    <Button
        primary={true}
        size='large'
        backgroundColor='#1ea7fd'
        fontFamily="'Trebuchet MS', 'Lucida Sans Unicode', 'Lucida Grande', 'Lucida Sans', Arial, sans-serif"
        label='Button Text'
    />

2. SignUp

Inside your component, import the SignUp form as follows:

import { SignUp } from '@mark33mark/react-component-library'

Options

No options available at this stage, will be adding some soon.

Example:

import { SignUp } from '@mark33mark/react-component-library';

    < SignUp />

Contributing

This work is not open for contributions as it is a private library that I will keep evolving over time... I hope 😜.

Credits

Articles:

• Gavin Macken - Medium

• Harika bv - Medium

Built With

• React
• Storybook to build components before adding to this library

Versioning

Using NPM for versioning.

Authors

• mark33mark - Initial work - mark33mark

License

© mark33mark