beardy-components v0.0.17

Beardy Components

A react component library for simple sites.

What makes Beardy Components different? Beardy Components has two categories of components. Base and Complex. Base components are your usual buttons, badges etc. Complex components are build up of the base components to create larges sections of a site (Like a footer).

Documentation: https://beardy-components.samuelbeard.net/

Installation

npm install --save beardy-components

Usage

Import individual components from 'beardy-components'.

import { Button } from 'beardy-components'

// ...

<Button>My Button</Button>

Development

To duplicate a component and automatically rename it, run:

npx generact

New Component Checklist

• src/components/[ComponentName]/[ComponentName].js
• src/components/[ComponentName]/index.js
• src/components/[ComponentName]/README.mdx
• Add new component to src/components/index.js

Default Styling Components

Put any styling that a user will want to change into the globalStyling.js.

To Do

• Build components
• Enable custom styling
  • Ask for a globalStyles.js?
  • Add unique classes to every element?
  • Provide a theme.css/theme.scss file?

Components to Build

Basics

• Button
• Alert
• Badge
• Breadcrumbs
• Card
• Modal
• Toast

Form

• Text Input

Typography

• Paragraph
• Anchor
• Heading

Layout

• Container
• Row
• Col
• Section
• Hero - Makes much larger headers?

Combined Components

• Footer
• Navbar