2.0.2 β€’ Published 5 years ago

panda-common-controls-ts v2.0.2

Weekly downloads
3
License
ISC
Repository
github
Last release
5 years ago

🐼 Panda Common Controls + TS

This library is basically the same as the panda-common-controls, but with a little more TypeScript and a little less Babel... actually is all TypeScript and zero Babel.

So in resume, it is the same but different and still the same.

This library came out as a personal project to create a list of reusable components and also as a test to build my first public module to use with NPM.

It contains some "fancy looking" components like:

  • Animations
  • Badges
  • Button
  • Calendar
  • Card
  • Checkbox
  • Dropdown List
  • Graphs
  • Icons
  • Menus Layout
  • Modals
  • RadioButton
  • Tabs
  • TextBox (an input tag with a little more functionality)
  • Toast Notifications
  • ToolTip

These components where created using the styled-componets library.

You can see them in action here.

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.

Installing

NOTE: In order to use these components you will need to install the styled-components and styled-theming packages.

npm install --save styled-components styled-theming

To install this module using npm just run this command:

npm install --save panda-common-controls

This will install the following files into your project:

    .
    β”œβ”€β”€ lib
    |     β”œβ”€β”€ animations
    |     |       └── animations.js
    |     β”œβ”€β”€ badges
    |     |       └── badges.js
    |     β”œβ”€β”€ buttons
    |     |       └── buttons.js
    |     β”œβ”€β”€ calendar
    |     |       β”œβ”€β”€ calendar.js
    |     |       β”œβ”€β”€ month.js
    |     |       β”œβ”€β”€ months.js
    |     |       └── years.js
    |     β”œβ”€β”€ cards
    |     |       └── cards.js
    |     β”œβ”€β”€ checkboxes
    |     |       └── checkboxes.js
    |     β”œβ”€β”€ dropdownlists
    |     |       └── dropdownlists.js
    |     β”œβ”€β”€ graphs
    |     |       └── graphs.js
    |     β”œβ”€β”€ icons
    |     |       └── icons.js
    |     β”œβ”€β”€ menus
    |     |       └── menus.js
    |     β”œβ”€β”€ modals
    |     |       └── modals.js
    |     β”œβ”€β”€ radiobuttons
    |     |       └── radiobuttons.js
    |     β”œβ”€β”€ tabs
    |     |       └── tabs.js
    |     β”œβ”€β”€ textboxes
    |     |       └── textboxes.js
    |     β”œβ”€β”€ toastnotifications
    |     |       └── toastnotifications.js
    |     └── tooltip
    |             └── tooltip.js
    β”œβ”€β”€ index.js
    β”œβ”€β”€ package.json
    └── README.md

For a complete list of the files, including a running examples and tests, you can check the GitHub repository.

Basic usage

Components

You can clone the repository, start it and check the meta-storybook page to see some of the components in action.

**To clone it**
git clone https://github.com/pecadorcelestial/panda-common-controls.git

**To start it**
npm start

Running the tests

The test where build using Jest and Enzyme, to run them just copy the repository and type:

npm test

This includes the coverage command.

Built With

Authors

  • Francisco RodrΓ­guez - Initial work - GitHub

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments