@cocokits/react-button
v1.2.0
Published
The `@cocokits/react-button` package provides essential UI components that enhance button interactions in React applications. The components included in this package are designed to be flexible, customizable, and easy to integrate into various design syst
Readme
@cocokits/react-button
The @cocokits/react-button package provides essential UI components that enhance button interactions in React applications. The components included in this package are designed to be flexible, customizable, and easy to integrate into various design systems.
This package includes the following components:
ButtonIconButton
Button
The Button component offers a customizable and flexible button element that can be easily styled to match any design system. It allows for different configurations, including varying button types, sizes, and colors. This component is ideal for standard UI actions such as submitting forms or triggering events.
Features:
- Customizable: Configure the size, color, and type of the button based on your design needs.
- Theming Compatibility: Works with multiple design system themes, maintaining visual consistency across your application.
- Flexible Configuration: Supports various button types like primary, secondary, or icon buttons.
IconButton
The IconButton component is a versatile UI element that integrates icons into button interfaces. It enhances user experience by combining text and icons or displaying an icon alone. This makes it perfect for visually representing actions such as navigating, editing, or deleting.
Features:
- Versatile Icon Integration: Display an icon alone or alongside text to represent different actions.
- Theming Compatibility: Seamlessly integrates with multiple design system themes, ensuring adaptability to the application's style.
- Customizable Appearance: Adjust the size, color, and other stylistic attributes for full control over the component's appearance.
Styling and Theming
The components in this package do not include any built-in styles. However, @cocokits/react-button adds CSS classes to the elements based on the provided configuration. You can style the components yourself or apply a theme from CocoKits.
CocoKits provides ready-made theming options, or you can create a custom design using your CSS or SCSS styles.
Documentation and Examples
For detailed usage examples, configuration options, and additional documentation, visit the following links:
Contributing
We welcome contributions! If you'd like to contribute to this project, please read our Contributing Guidelines
License
This project is licensed under the Apache License. See the LICENSE file for details.
