@sandypockets/components

0.7.1 • Public • Published

@sandypockets/components

A React component library, still very much under development. As the library works towards a 1.0.0 release, there will likely be large stylistic and functional overhauls. Until then, this package is not suitable for production.

License: MIT

Each component is styled with its own CSS module, so you don't have to worry about collisions with your existing code.

Installation

Add the package to your project:

yarn add @sandypockets/components

Usage

Once installed, import the package and use it like you would any other component.

import { Button } from '@sandypockets/components'

export default function MyComponent() {
  
  return (
    <div>
      <Button theme="primary">
        Click me
      </Button>
    </div>
  )
}
View button props
Attribute Prop Name Type Required default
aria-label accessibilityLabel string no null
className theme string no "primary"
disabled disabled boolean no false
style inlineStyle object no null
type type string no "button"
onClick onClickHandler function no null
onSubmit onSubmitHandler function no null

Current components

  • Avatar
  • Avatar group
  • Badge
  • Button
  • Modal
  • Text area

Live demo

Check out the demo on StackBlitz

Package Sidebar

Install

npm i @sandypockets/components

Weekly Downloads

0

Version

0.7.1

License

MIT

Unpacked Size

21 kB

Total Files

17

Last publish

Collaborators

  • sandypockets