@squidit/react-css
This repository contains a React component library developed to facilitate the creation of consistent and elegant interfaces, following a custom style guide. The included components are highly customizable and designed to be reusable across a variety of React projects.
## Welcome to Squid Design System
⚡ Get the experience by browsing one of [our platforms](https://app.squidit.com.br)!
This framework provides low level utilities and UI components for building
custom experiences.
## Style
Our Design System can be seen [here](https://css.squidit.com.br/styleguide)
## Components
UI Components are currently offered as React (Web) components.
## Installation
1. Node version >= 22
2. To use this library in your React project, you can install it via npm or yarn:
```Bash
npm install @squidit/css @squidit/react-css
```
or
```Bash
yarn add @squidit/css @squidit/react-css
```
3. Add to your style.scss main file
```scss
$fontsFolderPath: "@squidit/css/dist/fonts";
@import "@squidit/css/src/scss/squid.scss";
@import "@squidit/react-css/dist/style.css";
```
## How to Use
After installation, you can import and use the components as needed in your React components:
```jsx
import React from 'react';
import { SqButton } from '@squidit/react-css';
const MyComponent = () => {
return (
Click Here
);
};
export default MyComponent;
```
## Translations
The lib is available in English, Portuguese and Spanish. By default it is loaded in English, but you can change the lib language to Portuguese or Spanish as follows:
In your project's index, import the functions responsible for translating the lib, define the translation structure and call the translation function.
Here's an example on StackBlitz:
It is also possible to change translations for individual components, as shown in the example below
## Customization
This library allows high flexibility and customization of the components. You can modify the default styles of the components using specific props or by overriding the styles via CSS.
## License
This project is licensed under the [MIT License](LICENSE).