DBaseUI

DBaseUI is a reusable component library built with React and TypeScript. It aims to provide a set of flexible, modular, and easy-to-use UI components.

Table of Contents

• Installation
• Usage
• Components
• Contributing
• License

Installation

To install DBaseUI, run:

npm install @dbase-ui/dbase-ui

or

pnpm add @dbase-ui/dbase-ui

or

yarn add @dbase-ui/dbase-ui

Usage

Here's a quick example of how to use the Button component from DBaseUI:

import React from 'react';
import { Button } from '@dbase-ui/dbase-ui';

const App: React.FC = () => {
  return (
    <div>
      <Button variant="primary" size="lg">
        Primary Button
      </Button>
      <Button variant="secondary" size="sm">
        Secondary Button
      </Button>
    </div>
  );
};

export default App;

Components

Button

Props

| Prop | Type | Default | Description | | ---------- | ------------------------ | --------- | -------------------------- | | variant | primary | secondary | primary | The variant of the button. | | size | sm | md | lg | medium | The size of the button. | | children | React.ReactNode | | The content of the button. | | ... | ... | ... | ... |

Example

<Button variant="primary" size="large">Primary Button</Button>
<Button variant="secondary" size="small">Secondary Button</Button>

Contributing

We welcome contributions to DBaseUI! If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/branch).
3. Make your changes and commit them (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/branch).
5. Open a pull request.

Please make sure your code adheres to the project's coding standards and includes appropriate tests.

License

DBaseUI is licensed under the MIT License. See the LICENSE file for more information.