@mlw-packages/react-components 1.3.4 → 1.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +44 -41
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,50 +1,53 @@
1
- # React + TypeScript + Vite
1
+ # @malwee/react-components
2
2
 
3
- This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3
+ Uma biblioteca de componentes React reutilizáveis para acelerar o desenvolvimento de aplicações web com design consistente, acessível e moderno.
4
4
 
5
- Currently, two official plugins are available:
5
+ ## Instalação
6
6
 
7
- - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8
- - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9
-
10
- ## Expanding the ESLint configuration
7
+ ```bash
8
+ npm install @malwee/react-components
9
+ # ou
10
+ yarn add @malwee/react-components
11
+ ```
11
12
 
12
- If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
13
+ ## Uso Básico
13
14
 
14
- - Configure the top-level `parserOptions` property like this:
15
+ ```tsx
16
+ import { ButtonBase, CardBase } from '@malwee/react-components';
15
17
 
16
- ```js
17
- export default tseslint.config({
18
- languageOptions: {
19
- // other options...
20
- parserOptions: {
21
- project: ['./tsconfig.node.json', './tsconfig.app.json'],
22
- tsconfigRootDir: import.meta.dirname,
23
- },
24
- },
25
- })
18
+ function App() {
19
+ return (
20
+ <CardBase>
21
+ <ButtonBase>Meu botão</ButtonBase>
22
+ </CardBase>
23
+ );
24
+ }
26
25
  ```
27
26
 
28
- - Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
29
- - Optionally add `...tseslint.configs.stylisticTypeChecked`
30
- - Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
31
-
32
- ```js
33
- // eslint.config.js
34
- import react from 'eslint-plugin-react'
35
-
36
- export default tseslint.config({
37
- // Set the react version
38
- settings: { react: { version: '18.3' } },
39
- plugins: {
40
- // Add the react plugin
41
- react,
42
- },
43
- rules: {
44
- // other rules...
45
- // Enable its recommended rules
46
- ...react.configs.recommended.rules,
47
- ...react.configs['jsx-runtime'].rules,
48
- },
49
- })
27
+ ## Componentes Disponíveis
28
+
29
+ - Botões (`ButtonBase`)
30
+ - Cartões (`CardBase`)
31
+ - Inputs, Selects, Combobox, Checkbox, Switch, Tabs, Table, Tooltip, Dialog, Drawer, Sidebar, Avatar, Calendar, Carousel, Progress, Skeleton, Sonner, e outros.
32
+
33
+ Veja a lista completa na pasta `src/components/ui` ou exemplos em `src/pages`.
34
+
35
+ ## Estilos
36
+
37
+ Os componentes utilizam Tailwind CSS. Certifique-se de que seu projeto está configurado para usar Tailwind. Importe o CSS global:
38
+
39
+ ```tsx
40
+ import '@malwee/react-components/style/global.css';
50
41
  ```
42
+
43
+ ## Documentação
44
+
45
+ Consulte exemplos de uso e documentação dos componentes na pasta `src/pages`.
46
+
47
+ ## Contribuição
48
+
49
+ Contribuições são bem-vindas! Abra uma issue ou envie um pull request.
50
+
51
+ ## Licença
52
+
53
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mlw-packages/react-components",
3
- "version": "1.3.4",
3
+ "version": "1.3.5",
4
4
  "main": "dist/index.js",
5
5
  "module": "dist/index.mjs",
6
6
  "types": "dist/index.d.ts",