@berlitz/button

Button component for the Max Design System

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@berlitz/button
Minified + gzip package size for @berlitz/button in KB

Readme

Button npm version

The Berlitz Button component has two styles available: Primary Button, Ghost White (Transparent fill). This component comes with additional options and states, such as loading, disabled, full width and an option to append icon after the label.

Installation

yarn add @berlitz/button

Props

Argument Type Required Default Example
canLoad bool null
children oneOfType([string, node] null
onClick function null
ghost bool null
icon node null
type string 'button'
buttonType string 'default'
fullWidth bool or arrayOf['xs', 'sm', 'md', 'lg', 'xl'] null
small bool or arrayOf['xs', 'sm', 'md', 'lg', 'xl'] null

Usage

import React from 'react'
import Button from '@berlitz/button'
const MyApp = () => (
  <>
    <h1>Get Started</h1>
    <Button>Let's Go</Button>
  </>
)

When to use this component

  • Call to action Button
  • Submit Button

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.