@rubeusteam/rb-angular-components 0.0.0-dev.0

package/README.md

@@ -0,0 +1,119 @@
+# RbAngularComponents
+
+Este projeto foi gerado usando o [Angular CLI](https://github.com/angular/angular-cli) versão 19.1.8.
+
+This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.1.8.  
+
+## Visão Geral | Overview 
+
+RbAngularComponents é uma biblioteca de componentes, diretivas, serviços e pipes Angular criada para acelerar o desenvolvimento de interfaces com consistência e boas práticas.
+
+RbAngularComponents is a library of Angular components, directives, services, and pipes designed to accelerate UI development with consistency and best practices.  
+
+## Requisitos
+
+- Angular >= 15 (suporta componentes standalone)  
+- Node.js >= 18.x  
+- npm >= 9.x  
+- Angular Material (alguns componentes são baseados nele)
+
+## Requirements
+
+- Angular >= 15 (supports standalone components)  
+- Node.js >= 18.x  
+- npm >= 9.x  
+- Angular Material (some components are based on it)  
+
+## Instalação | Installation
+
+Instale a biblioteca via npm:
+
+Install the library via npm:  
+
+```bash
+npm install rb-angular-components
+```
+
+## Uso em Componentes Standalone | Usage in Standalone Components
+
+Você pode importar qualquer componente, diretiva ou pipe diretamente em seu componente standalone.
+
+You can import any component, directive, or pipe directly into your standalone component.  
+
+```ts
+import { RbCrudComponent } from 'rb-angular-components';
+
+@Component({
+  standalone: true,
+  imports: [RbCrudComponent],
+  selector: 'app-demo',
+  template: '<rb-crud></rb-crud>'
+})
+export class DemoComponent {}
+```
+
+## Uso em Módulos Angular (NgModules) | Usage in Angular Modules (NgModules) 
+
+Se seu projeto usa NgModules, ainda assim você pode usar os componentes standalone importando-os no array `imports`.
+
+If your project uses NgModules, you can still use the standalone components by importing them in the `imports` array.  
+
+```ts
+import { NgModule } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { RbCrudComponent } from 'rb-angular-components';
+
+@NgModule({
+  imports: [
+    CommonModule,
+    RbCrudComponent // standalone component
+  ]
+})
+export class MyModule {}
+```
+
+> Opcionalmente, você pode criar um módulo compartilhado que agrupe e exporte todos os componentes standalone para conveniência.
+
+> Optionally, you can create a shared module that groups and exports all standalone components for convenience.  
+
+
+## Recursos Disponíveis
+
+- Componentes (ex: `RbCrudComponent`, `RbFilterComponent`)  
+- Diretivas (ex: `RbDynamicButtonDirective`)  
+- Pipes (ex: `RbCustomPipe`)  
+- Serviços (ex: `ClientFilterService`)  
+- Traduções (ex: `PaginatorPtbrIntlService`)
+
+## Available Resources
+
+- Components (e.g., `RbCrudComponent`, `RbFilterComponent`)  
+- Directives (e.g., `RbDynamicButtonDirective`)  
+- Pipes (e.g., `RbCustomPipe`)  
+- Services (e.g., `ClientFilterService`)  
+- Translations (e.g., `PaginatorPtbrIntlService`)
+
+
+## Documentação por Recurso | Documentation by Feature 
+
+Você pode acessar a documentação de cada recurso em sua respectiva pasta:
+
+You can access documentation for each feature in its respective folder:  
+
+- [`components/rb-content-box`](./src/lib/components/rb-content-box/README.md)  
+- [`components/rb-crud`](./src/lib/components/rb-crud/README.md)  
+- [`components/rb-filter`](./src/lib/components/rb-filter/README.md)  
+- [`components/rb-dialog`](./src/lib/components/rb-dialog/README.md)  
+- [`directives/rb-dynamic-button`](./src/lib/directives/rb-dynamic-button/README.md)  
+- [`pipes/rb-custom`](./src/lib/pipes/rb-custom/README.md)  
+- [`services/client-filter`](./src/lib/services/client-filter/README.md)  
+- [`i18n/paginator-ptbr-intl`](./src/lib/i18n/paginator-ptbr-intl/README.md)
+
+---
+
+## Recursos Adicionais | Additional Resources 
+
+Para uso do Angular CLI e comandos, veja a [Referência do Angular CLI](https://angular.dev/tools/cli).
+
+For Angular CLI usage and commands, see the [Angular CLI Reference](https://angular.dev/tools/cli).  
+