norma-library 0.0.9 → 0.1.1

package/README.md

@@ -1,27 +1,105 @@
-# React + TypeScript + Vite
+# Como usar um pacote Norma Library
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+O npm (Node Package Manager) é um gerenciador de pacotes para o ambiente Node.js, permitindo que você instale e gerencie bibliotecas e pacotes em seus projetos. Neste guia, você aprenderá como usar um pacote Norma Library em seu projeto.
 
-Currently, two official plugins are available:
+Repository GitHub [Norma LIbrary](https://github.com/OlosLive/norma-libraryp).
 
-- [@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
+## Passos Básicos
 
-## Expanding the ESLint configuration
+### 1. Instalando o pacote em seu projeto
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+Para instalar o pacote Norma em seu projeto execute o comando em seu terminal:
 
-- Configure the top-level `parserOptions` property like this:
+### `npm install norma-library`
 
-```js
-   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-   },
-```
+## Components disponível e como usa-lo
 
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+### Button
+
+`import { Button } from "norma-library`;
+
+`<Button label="Clique-me" onClick={handleButtonClick} />`;
+
+#### Props
+
+O componente `Button` aceita as seguintes propriedades:
+
+- `label` (string, obrigatório): O texto exibido no botão.
+- `sx` (SxProps<Theme>): Estilos personalizados usando o sistema de estilos do Material-UI.
+- `color` (string): A cor do botão (inherit, primary, secondary, success, error, info, warning).
+- `size` (string): O tamanho do botão (small, medium, large).
+- `variant` (string): A variante do botão (text, outlined, contained).
+- `style` (React.CSSProperties): Estilos CSS adicionais.
+- `children` (ReactNode): Conteúdo adicional a ser exibido dentro do botão.
+- `onClick` (função): Uma função de callback para ser executada quando o botão for clicado.
+
+### Card
+
+`import { Card } from "norma-library`;
+
+`<Card title="Titulo do cartão" />conteúdo do card</card>`;
+
+#### Props
+
+O componente `Card` aceita as seguintes propriedades:
+
+- `title` (string, opcional): O título exibido no cabeçalho do card, se fornecido.
+- `children` (ReactNode, obrigatório): O conteúdo do card, que pode incluir qualquer componente ou conteúdo.
+
+### Modal
+
+`import { Modal} from "norma-library`;
+
+`<Modal open={open} onClose={handleClose} aria-labelledby="modal-modal-title" aria-describedby="modal-modal-description" onConfirm={handleConfirm}
+title="Titulo do modal">conteúdo do modal</modal>`;
+
+#### Props
+
+O componente `Modal` aceita as seguintes propriedades:
+
+- `sx` (SxProps<Theme>): Estilos personalizados usando o sistema de estilos do Material-UI.
+- `children` (React.ReactElement | React.ReactElement[]): Elementos filhos do modal.
+- `open` (boolean): Indica se o modal está aberto.
+- `onClose` (função): Função de callback chamada quando o modal é fechado.
+- `className` (string): Classe CSS adicional para estilização.
+- `title` (string): Título do modal.
+- `full` (boolean): Indica se o modal deve ocupar toda a largura.
+- `onConfirm` (função): Função de callback chamada quando o botão "Confirmar" é clicado.
+
+### TextField
+
+`import { TextField } from "norma-library`;
+
+`<TextField id="outlined-basic" label="Outlined" variant="outlined" />`;
+
+#### Props
+
+O componente `TextField` aceita as seguintes propriedades:
+
+- `label` (ReactNode): Rótulo exibido acima do campo de entrada.
+- `variant` (string): A variante do campo (standard, outlined, filled).
+- `value` (TextFieldValue): O valor do campo de entrada.
+- `onChange` (função): Função de callback chamada quando o valor do campo muda.
+- `disabled` (boolean): Indica se o campo de entrada está desabilitado.
+- `required` (boolean): Indica se o campo de entrada é obrigatório.
+- `hasError` (boolean): Indica se o campo de entrada possui erro.
+- E outras propriedades relacionadas a estilos, tamanho, id, etc.
+
+### CheckBox
+
+`import { CheckBox } from "norma-library`;
+
+`<CheckBox id="checkbox-basic" label="Checkbox" label="Selecionar" checked={checked} onChange={handleCheckboxChange} />`;
+
+#### Props
+
+O componente `CheckBox` aceita as seguintes propriedades:
+
+- `label` (ReactNode): Rótulo exibido acima do campo de entrada.
+- `checked ` (boolean): Indica se a caixa de seleção está marcada.
+- `onChange` (função): Função de callback chamada quando o valor do campo muda.
+- `disabled` (boolean): Indica se o campo de entrada está desabilitado.
+- `color ` (string): A cor da caixa de seleção (primary, secondary, error, info, success, warning, default).
+- `size ` (string): O tamanho da caixa de seleção (small, medium).
+- `value` (TextFieldValue): O valor do campo de entrada.
+- E outras propriedades relacionadas a estilos, required, id, etc.

package/dist/components/Form/CheckBox/index.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { CheckBoxBaseProps } from './types';
+export declare const CheckBox: React.FC<CheckBoxBaseProps>;
+//# sourceMappingURL=index.d.ts.map

package/dist/components/Form/CheckBox/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAK3C,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAMhD,CAAA"}

package/dist/components/Form/CheckBox/types.d.ts

@@ -0,0 +1,21 @@
+import { OverridableStringUnion } from '@mui/types';
+import { CheckboxProps as MuiCheckBoxProps, SxProps, Theme } from '@mui/material';
+import { SwitchBaseProps } from '@mui/material/internal/SwitchBase';
+export interface CheckboxPropsSizeOverrides {
+}
+export interface CheckboxPropsColorOverrides {
+}
+export type CheckBoxBaseProps = Pick<MuiCheckBoxProps, 'sx'> & {
+    sx?: SxProps<Theme>;
+    name?: string;
+    checked?: SwitchBaseProps['checked'];
+    color?: OverridableStringUnion<'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | 'default', CheckboxPropsColorOverrides>;
+    disabled?: SwitchBaseProps['disabled'];
+    id?: SwitchBaseProps['id'];
+    onChange?: SwitchBaseProps['onChange'];
+    required?: SwitchBaseProps['required'];
+    size?: OverridableStringUnion<'small' | 'medium', CheckboxPropsSizeOverrides>;
+    value?: SwitchBaseProps['value'];
+    defaultChecked?: boolean;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/components/Form/CheckBox/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,EAAmB,aAAa,IAAI,gBAAgB,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAClG,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAGnE,MAAM,WAAW,0BAA0B;CAAG;AAE9C,MAAM,WAAW,2BAA2B;CAAG;AAE/C,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,GAAG;IAC7D,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;IACpC,KAAK,CAAC,EAAE,sBAAsB,CAC5B,SAAS,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,EAC9E,2BAA2B,CAC5B,CAAA;IACD,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACtC,EAAE,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC,CAAA;IAC1B,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACtC,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACtC,IAAI,CAAC,EAAE,sBAAsB,CAAC,OAAO,GAAG,QAAQ,EAAE,0BAA0B,CAAC,CAAA;IAC7E,KAAK,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,CAAA;IAChC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA"}

package/dist/components/index.d.ts

@@ -1,11 +1,14 @@
 export type { ButtonBaseProps } from './Layout/Button/types';
 export type { CardBaseProps } from './Layout/Card/types';
-export type { IconsProps } from './Data/Icon/types';
 export type { ModalBaseProps } from './Layout/Modal/types';
+export type { IconsProps } from './Data/Icon/types';
+export type { TextFieldBaseProps } from './Form/TextField/types';
+export type { CheckBoxBaseProps } from './Form/CheckBox/types';
 export { Button } from './Layout/Button';
 export { Card } from './Layout/Card';
 export { Modal } from './Layout/Modal';
 export { TextField } from './Form/TextField';
+export { CheckBox } from './Form/CheckBox';
 export { Icons as DefaultIconSVG } from './Data/Icon/DefaultIcon';
 export { Icons as NormaIconSVG } from './Data/Icon/NormaIcon';
 export { palette, lightTheme, darkTheme } from '@helpers/colors';

package/dist/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAC5D,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACxD,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnD,YAAY,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAE5C,OAAO,EAAE,KAAK,IAAI,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,EAAE,KAAK,IAAI,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAE7D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAC5D,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACxD,YAAY,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAEnD,YAAY,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAChE,YAAY,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAE9D,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE1C,OAAO,EAAE,KAAK,IAAI,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,EAAE,KAAK,IAAI,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAE7D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA"}