1.11.1 • Published 5 months ago

bik-button v1.11.1

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

Button Component

A reusable, customizable, and accessible button component for React applications. Supports multiple variants, loading states, and additional customizations.

📦 Installation

npm install bik-button

or

yarn add bik-button

🚀 Usage

Basic Example

import React from "react";
import { Button } from "bik-button";

const App = () => {
  return (
    <div>
      <Button title="Click Me" onClick={() => alert("Button Clicked")} />
    </div>
  );
};

export default App;

Using Variants

<Button variant="primary">Primary</Button>
<Button variant="primary-line">Primary Line</Button>
<Button variant="secondary">Secondary</Button>
<Button variant="secondary-line">Secondary Line</Button>
<Button variant="blue">Blue</Button>
<Button variant="red">Red</Button>
<Button variant="green">Green</Button>
<Button variant="yellow-outline">Yellow Outline</Button>

Button with Icon

<Button variant="primary">
  <span>🚀 Launch</span>
</Button>

Loading State

<Button variant="primary" loading>
  Loading...
</Button>

Disabled State

<Button variant="primary" disabled>
  Disabled
</Button>

🎨 Variants

The button supports multiple styles. Use the variant prop to define a style.

VariantDescription
primarySolid primary button (default)
primary-lineOutlined primary button
secondarySolid secondary button
secondary-lineOutlined secondary button
secondary-line-borderedBordered secondary button
blueSolid blue button
blue-lineOutlined blue button
blue-line-borderedBordered blue button
redSolid red button
red-lineOutlined red button
red-line-borderedBordered red button
pinkSolid pink button
pink-outlineOutlined pink button
pink-outline-borderedBordered pink button
greenSolid green button
green-outlineOutlined green button
grayGray button
yellow-outlineOutlined yellow button

Props

PropTypeDefaultDescription
titlestring""Text inside the button
childrenReactNodenullAny React element inside button
type"button" \| "submit" \| "reset""button"Button type
variantTVariant"primary"Button style (see variants table)
onClick(ev: MouseEvent<HTMLButtonElement>) => voidundefinedClick event handler
classNamestring""Additional CSS classes
disabledbooleanfalseDisables the button
loadingbooleanfalseShows loading spinner

🛠 Custom Styles

You can override styles using the className prop.

<Button className="custom-button">Custom Styled Button</Button>

🔗 License

This project is licensed under the MIT License.


👨‍💻 Author

Created by bikiran.com. Feel free to contribute!

1.11.1

5 months ago

1.11.0

5 months ago

1.10.0

5 months ago

1.9.0

6 months ago

1.8.0

6 months ago

1.7.0

6 months ago

1.6.0

6 months ago

1.5.0

6 months ago

1.4.0

6 months ago

1.3.0

6 months ago

1.2.0

6 months ago

1.0.0

6 months ago