README.md

mega-card

---

A React card component.

📝 Table of Contents

• About
• Installing
• Usage
• Options
• Built Using
• Todo
• Author
• Acknowledgments

🧐 About

mega-card serves as a simple card component.

📦 Installing

NPM

npm install mega-card

Yarn

yarn add mega-card

🎈 Usage

import React from 'react'
import Navvy from 'navvy'

const App = () => {
  return <MegaCard />
}

export default App

⚙ Options

{
  background: 'white' // Background color.
  color: 'blue' // Theme color.
  data: '$100.00' // Data to display.
  icon: 'Info' // Grommet Icon to display.
  indicator: true // Whether or not to display an indicator bubble.
  shadowSize: 'small' // Size of box-shadow
  shadowType: 'dark' // Color of box-shadow.
  title: 'Title' // Title to display.
  titleColor: 'blue' // Color of Title.
  type: 'card' // Type of MegaCard to render.
}

⛏️ Built Using

• Grommet - UI Framework
• React - UI Framework

✏️ TODO

• [] Add tests.

✍️ Author

• Alex Lee - Developer

🎉 Acknowledgements

• Icon made by Freepik from www.flaticon.com and is licensed by CC 3.0 BY.