https://github.com/fblettner/liberty-test
https://github.com/fblettner/liberty-test
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fblettner/liberty-test
- Owner: fblettner
- License: agpl-3.0
- Created: 2025-02-13T17:30:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-24T15:25:14.000Z (over 1 year ago)
- Last Synced: 2025-07-08T21:47:53.204Z (11 months ago)
- Language: TypeScript
- Size: 12.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# **Liberty Core**
## **Overview**
**Liberty Core** is a reusable component library designed for React applications. It provides a collection of UI components, utilities, and styles to streamline development. This package includes pre-styled components, utility functions, and common types, making it an essential part of the Liberty Framework.
This repository contains an application for testing all components and how to use them
## **Features**
- 🎨 **Theme & Styling**: Centralized theme management.
- 🏗️ **Prebuilt UI Components**: Includes buttons, dialogs, typography, tables, alerts, and more.
- ⚙️ **Utility Functions**: Common helper functions for improved developer experience.
- 🛠️ **Type Definitions**: Predefined TypeScript types for consistent data handling.
- 🔌 **Easy Integration**: Works seamlessly with any React project.
## Try It Online!
[](https://stackblitz.com/~/github.com/fblettner/liberty-test)
## **Installation**
To install **Liberty Core**, run the following command:
```sh
npm install liberty-core
```
or with Yarn:
```sh
yarn add liberty-core
```
## **Usage**
### **1. Import Components**
You can import and use any component from **Liberty Core** directly in your React app:
```tsx
import { Button, Dialog, Alert } from "liberty-core";
const App = () => {
return (
This is a success alert!
console.log("Clicked!")}>Click Me
This is a sample dialog.
);
};
export default App;
```
### **2. Theming**
Liberty Core provides a customizable theme. Wrap your application in a `ThemeProvider` to apply the default or custom theme:
```tsx
import { ThemeProvider, theme } from "liberty-core";
const App = () => {
return (
);
};
```
### **3. Utility Functions**
Liberty Core includes common utility functions that can be used across your application:
```tsx
import { formatDate } from "liberty-core";
const date = formatDate(new Date());
console.log(date); // Output: Formatted date
```
## **Available Components**
Liberty Core exports various components categorized as **styles**, **common components**, and **utilities**.
### **🖌 Styles**
```ts
import {
theme, icons, Button, Dialog, Div, IconButton, Main, Menus, Paper, Stack, Typography
} from "liberty-core";
```
### **📦 Common Components**
```ts
import {
Alert, AlertMessage, Button, Card, Checkbox, CircularProgress, Collapse,
ConfirmationDialog, Dialog, Divider, Flex, FlexAdvanced, Grid, IconButton,
Input, List, LoadingIndicator, MarkDown, Menus, Popper, Select, Skeleton,
SnackMessage, Tab, Table, Toggle, Tooltip, Tree, Typography, UseMediaQuery
} from "liberty-core";
```
### **⚙️ Utility Functions & Types**
```ts
import { commonUtils } from "liberty-core";
import { commonTypes } from "liberty-core";
```
## **License**
liberty-core is **open-source software** licensed under the **AGPL License**.
```
Copyright (c) 2025 NOMANA-IT and/or its affiliates.
All rights reserved. Use is subject to license terms.
```
## 📧 Contact & Support
If you have questions or need support:
- **Email**: [franck.blettner@nomana-it.fr](mailto:franck.blettner@nomana-it.fr)
- **GitHub Issues**: [Report an issue](https://github.com/fblettner/liberty-core/issues)
- **Discussions**: Join the conversation in the **GitHub Discussions** section.
---
### ⭐ If you find Liberty Core useful, consider giving it a star on GitHub!
```bash
git clone https://github.com/fblettner/liberty-core.git
cd liberty-core
```
---
## 💖 Sponsorship
If you find **Liberty Core** useful and would like to support its development, consider sponsoring us. Your contributions help maintain the project, add new features, and improve the documentation. Every contribution, big or small, is greatly appreciated!
To sponsor, visit: **[GitHub Sponsors](https://github.com/sponsors/fblettner)** or reach out to us directly.
---