Skip to content
technical-documenter edited this page Oct 7, 2026 · 9 revisions

ui-people

Controle Online

Site institucional Doação App-Home API-Home

Objetivo

@controleonline/ui-people é o módulo React/React Native responsável por todo o ciclo de vida de pessoas (pessoas físicas e jurídicas) no ecossistema ControleOnline.

Cobre busca, exibição, criação, edição de perfil, endereços, documentos, telefones, e-mails e os vínculos de contexto (cliente, fornecedor, colaborador, franquia, etc.).


Índice da wiki técnica

Categoria Página
📦 Instalação e configuração Instalacao
📐 Arquitetura e módulos Arquitetura
📋 Contratos e exports Contratos
⚙️ Regras de negócio Regras-de-Negocio
🔄 Fluxos de cadastro por finalidade Cadastro-de-Pessoas
🔤 Capitalização de nomes ui-customers — People Name Case
🗂️ Store (estado) Store
👥 Lista colaboradores / filtros linkType e regra PF da currentCompany People-List-LinkType-Filters-Employees-Index
🧾 Cadastro completo (PF/PJ, contatos, usuários, vendedores) Cadastro-de-Pessoas-Contatos-Usuarios-e-Vendedores

Acesso rápido

Destino Link
Repositório https://github.com/ControleOnline/ui-people
npm package @controleonline/ui-people
Wiki principal (app) https://github.com/ControleOnline/app-community/wiki
Wiki complementar (API) https://github.com/ControleOnline/api-community/wiki
Documentação para clientes https://ajuda.controleonline.com/

Resumo funcional

O módulo ui-people fornece:

  1. Página People — listagem paginada de pessoas com filtros de contexto (cliente, fornecedor, funcionário, etc.), busca, avatar, e abertura de modal de criação.
  2. Página Profile — visualização e edição do perfil do usuário logado (nome, alias, foto, telefone, endereço, documentos).
  3. Página PeopleDomainsPage — gerenciamento de domínios de acesso vinculados à pessoa/empresa.
  4. Página PeopleDomainDetailPage — detalhe de um domínio específico.
  5. Página MyCompaniesPage — visão de empresas às quais o usuário tem vínculo (owner, director, manager, etc.).
  6. Componente PeopleAvatar — avatar universal para pessoas físicas e jurídicas.
  7. Componente AddCompanyModal — modal de criação/vinculação de empresa/pessoa.
  8. Componente PeopleAddressesPanel — painel de endereços de uma pessoa.

Visões de produto (APP_TYPE)

APP_TYPE Papel do módulo
MANAGER Gerencia clientes, fornecedores, funcionários e franqueados
CRM Gerencia prospects e clientes com contexto de funil
POS Lookup de cliente/fornecedor na emissão de pedido
DELIVERY Gerencia entregadores (courier) e clientes
SERVICE Gerencia clientes do serviço
ADMIN Gestão completa de todas as pessoas da plataforma

Clone this wiki locally