https://github.com/flexcodelabs/flexcodelabs-button

https://github.com/flexcodelabs/flexcodelabs-button

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/flexcodelabs/flexcodelabs-button
• Owner: flexcodelabs
• Created: 2022-07-30T10:20:07.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-07-31T11:48:23.000Z (over 2 years ago)
• Last Synced: 2023-03-11T18:46:15.755Z (almost 2 years ago)
• Language: TypeScript
• Size: 629 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# @flexcodelabs/button

[![npm](https://img.shields.io/npm/v/@flexcodelabs/button)](https://www.npmjs.com/package/@flexcodelabs/button) [![NPM](https://img.shields.io/npm/l/@flexcodelabs/button)](https://www.npmjs.com/package/@flexcodelabs/button)

- [Packe Component](#@flexcodelabs/button)

  - [Features](#features)

  - [Installation](#Installation)

  - [Usage](#usage)

  - [Examples](#examples)

  - [Props](#props)

## Features

- Loader

- Disabled

- Icon or Text or Both

- can be used as link

## Installation

`npm install @flexcodelabs/button`

or

`yarn add @flexcodelabs/button`

## Usage

```js

import Button from "@flexcodelabs/button";

;

```

## Examples

[Source code](https://github.com/flexcodelabs/flexcodelabs-button)

## Props

| Name      | Type                                     | Default | Required | Description                                  |

| --------- | ---------------------------------------- | ------- | -------- | -------------------------------------------- |

| label     | `ReactNode or string`                    | ``      | `false`  | Button content                               |

| style     | `CSSProperties`                          | ``      | `false`  | Custome styles                               |

| className | `string`                                 | ``      | `false`  | Custom classname                             |

| ripple    | `boolean`                                | ``      | `false`  | Whether to add ripple effect on button click |

| disabled  | `boolean`                                | ``      | `false`  | Button disabled status                       |

| type      | `button or submit or reset or undefined` | ``      | `false`  |                                              |

| href      | `string`                                 | ``      | `false`  | destination for next projects                |

| to        | `string`                                 | ``      | `false`  | destination for react router dom             |

| Link      | `any`                                    | ``      | `false`  | can be Link from react router or next/link   |

| loading   | `boolean`                                | ``      | `false`  | buttonloading status                         |