@logxero/ui_kit v1.0.0-a.1.0.7

LogXero - UI Kit

@logxero/ui-kit is a collection of reusable and customizable components for building beautiful user interfaces in React.

Features

• A comprehensive set of UI components.
• Customizable styles using a CSS configuration file.
• Built with performance and accessibility in mind.
• Easy integration with popular frameworks and libraries.

Installation

To use @logxero/ui-kit in your React project, you need to follow these steps:

1. Install the package using npm or Yarn:

   npm install @logxero/ui-kit

   or

   yarn add @logxero/ui-kit

2. Import the components you need in your project:

   import { Button, Card, Modal } from '@logxero/ui-kit';

3. Start using the components in your React application.

   Usage

   Here's an example of how you can use the Button component:

   import React from 'react';
   import { Button } from '@logxero/ui-kit';
   
   function App() {
   return (
   <div>
     <Button onClick={() => console.log('Button clicked!')}>
       Click me
     </Button>
   </div>
   )}

   Customization

   You can customize the styles of the components by modifying the CSS configuration file. The configuration file allows you to define colors, spacing, typography, and more. To customize the UI Kit styles, follow these steps:

   1. Locate the 'lx.config.js' file in the root of your project.

   2. Open the file and modify the values according to your preferences:

      module.exports = {
      colors: {
          primary: '#FF0000',
          secondary: '#00FF00',
          // ...
      },
      spacing: {
          small: '8px',
          medium: '16px',
          // ...
      }};

   3. Save the file, and the UI Kit components will reflect the updated styles.

License

The assets included in LogXero - UI Kit are proprietary and subject to the following license terms:

1. Permitted Use: You are granted a non-exclusive, non-transferable, and revocable license to use the assets solely for the purpose of incorporating them into your own projects or applications.

2. Restrictions: You are prohibited from redistributing, reselling, or sublicensing the assets, whether in their original form or modified. You may not make the assets available to third parties as standalone products or as part of a competing UI kit or similar product.

3. Attribution: While not required, it is appreciated if you provide attribution to LogXero - UI Kit in your project's documentation or credits. Attribution can be as simple as mentioning "UI components from LogXero - UI Kit " or including a link to the project's website.

4. Ownership: The assets included in LogXero - UI Kit remain the property of LogXero. You do not acquire any ownership rights to the assets, and this license does not grant you any intellectual property rights.

5. No Warranty: The assets are provided "as is" without any warranty or guarantee of fitness for a particular purpose. LogXero shall not be liable for any damages or liabilities arising out of the use or inability to use the assets.

Usage Agreement

By using the assets included in LogXero - UI Kit , you agree to abide by the terms and conditions of this license. If you do not agree with these terms, you are prohibited from using the assets.

Contact

If you have any questions regarding the licensing or permitted use of the assets in LogXero - UI Kit , please contact Nischal Timalsina at contact@nischaltimalsina.com.np.

Note: This license is a sample and should be customized to reflect the specific terms and conditions that apply to your proprietary assets. It is always recommended to consult with a legal professional to ensure that your license accurately reflects your intentions and protects your rights.