karsten-design-system 1.0.0 → 1.0.1

package/README.md

@@ -1,50 +1,141 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@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
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-export default tseslint.config({
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
-```
-
-- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
-- Optionally add `...tseslint.configs.stylisticTypeChecked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
-
-```js
-// eslint.config.js
-import react from 'eslint-plugin-react'
-
-export default tseslint.config({
-  // Set the react version
-  settings: { react: { version: '18.3' } },
-  plugins: {
-    // Add the react plugin
-    react,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended rules
-    ...react.configs.recommended.rules,
-    ...react.configs['jsx-runtime'].rules,
-  },
-})
+# Karsten Design System
+
+Uma biblioteca de componentes React estilizados para projetos da Karsten, construída sobre o PrimeReact.
+
+## Instalação
+
+Com npm:
+```bash
+npm install karsten-design-system
+```
+
+Com yarn:
+```bash
+yarn add karsten-design-system
+```
+
+## Pré-requisitos
+
+Esta biblioteca requer as seguintes dependências:
+
+- React 18 ou superior
+- PrimeReact 10 ou superior
+- React DOM 18 ou superior
+
+## Como usar
+
+1. Importe o componente desejado da biblioteca:
+
+```jsx
+import { Button } from 'karsten-design-system';
+```
+
+2. Use o componente em seu projeto:
+
+```jsx
+function App() {
+  return (
+    <Button label="Clique aqui" />
+  );
+}
+```
+
+## Componentes Disponíveis
+
+[Liste aqui os componentes disponíveis na sua biblioteca com uma breve descrição de cada um]
+
+Por exemplo:
+
+- `Accordion` - Componente para exibir conteúdo em seções expansíveis e colapsáveis.
+- `AutoComplete` - Campo de entrada com sugestões automáticas baseadas no texto digitado.
+- `Breadcrumb` - Navegação hierárquica para indicar a localização atual do usuário.
+- `Button` - Botão estilizado com variantes primária e secundária.
+- `Card` - Contêiner estilizado para exibir informações agrupadas.
+- `Chart` - Gráficos para visualização de dados em diferentes formatos.
+- `DateInput` - Campo de entrada para seleção de datas.
+- `Dialog` - Modal para exibição de mensagens ou ações secundárias.
+- `Divider` - Linha divisória para separação visual de conteúdo.
+- `FilterButton` - Botão para aplicar ou remover filtros em listas ou tabelas.
+- `Header` - Cabeçalho estilizado para títulos ou menus.
+- `IconButton` - Botão com ícone, ideal para ações rápidas.
+- `InfoCard` - Cartão informativo para exibir alertas ou dados destacados.
+- `Input` - Campo de entrada para texto.
+- `InternalMenu` - Menu de navegação interna, útil para dashboards.
+- `Link` - Link estilizado para navegação.
+- `MegaMenu` - Menu expandido com múltiplas opções organizadas.
+- `Notification` - Notificação para exibir alertas e mensagens.
+- `Paginator` - Paginação para navegação em listas ou tabelas.
+- `RadioButton` - Botões de seleção única dentro de um grupo.
+- `Select` - Componente para seleção de opções em um menu suspenso.
+- `Sidebar` - Barra lateral para navegação ou exibição de conteúdo adicional.
+- `Skeleton` - Elementos de carregamento em estilo esqueleto.
+- `Spinner` - Indicador de carregamento animado.
+- `Table` - Tabela para exibição de dados estruturados.
+- `Toast` - Mensagens temporárias exibidas no canto da tela.
+
+
+## Documentação
+
+Para uma documentação completa e exemplos, visite nosso [Storybook](link-do-seu-storybook).
+
+## Desenvolvimento
+
+Para contribuir com o projeto:
+
+1. Clone o repositório
+```bash
+git clone https://github.com/3035tech/karsten-design-system
+```
+
+2. Instale as dependências
+
+Com npm:
+```bash
+npm install
+```
+
+Com yarn:
+```bash
+yarn
+```
+
+3. Execute o Storybook para desenvolvimento
+
+Com npm:
+```bash
+npm run storybook
+```
+
+Com yarn:
+```bash
+yarn storybook
+```
+
+## Scripts Disponíveis
+
+Com npm:
+- `npm run storybook` - Inicia o ambiente de desenvolvimento do Storybook
+- `npm run build` - Gera o build da biblioteca
+
+Com yarn:
+- `yarn storybook` - Inicia o ambiente de desenvolvimento do Storybook
+- `yarn build` - Gera o build da biblioteca
+
+
+## Suporte
+
+Para suporte, entre em contato com 3035tech@3035tech.com.br.
+
+## Resolução de Problemas
+
+Se você encontrar o erro "peer dependencies missing", instale as dependências necessárias:
+
+Com npm:
+```bash
+npm install react react-dom primereact
+```
+
+Com yarn:
+```bash
+yarn add react react-dom primereact
 ```

package/dist/mock/internalMenu.d.ts

@@ -1,2 +1,2 @@
-import { InternalMenuItems as Type } from "../types/internalMenu";
+import { InternalMenuItems as Type } from '../types/internalMenu';
 export declare const InternalMenuItems: Type[];

package/dist/stories/components/infoCard.d.ts

@@ -3,6 +3,8 @@ type InfoCardProps = {
     title: string;
     children: ReactNode;
     icon?: ReactNode;
+    className?: string;
+    titleClassName?: string;
 };
-export default function InfoCard({ title, children, icon }: InfoCardProps): import("react/jsx-runtime").JSX.Element;
+export default function InfoCard({ title, children, icon, className, titleClassName, }: InfoCardProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/stories/screens/accountsPayable.d.ts

@@ -0,0 +1 @@
+export default function AccountsPayable(): import("react/jsx-runtime").JSX.Element;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "karsten-design-system",
   "description": "Kasrten Design System Components",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -25,9 +25,7 @@
   },
   "peerDependencies": {
     "react": "^18.3.1",
-    "react-dom": "^18.3.1"
-  },
-  "dependencies": {
+    "react-dom": "^18.3.1",
     "@types/date-fns": "^2.6.3",
     "chart.js": "^4.4.7",
     "clsx": "^2.1.1",